Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/nhn/toast-ui.vue-editor
This repository is DEPRECATED! GO TO 👉 https://github.com/nhn/tui.editor/tree/master/apps/vue-editor
https://github.com/nhn/toast-ui.vue-editor
editor vue
Last synced: 3 months ago
JSON representation
This repository is DEPRECATED! GO TO 👉 https://github.com/nhn/tui.editor/tree/master/apps/vue-editor
- Host: GitHub
- URL: https://github.com/nhn/toast-ui.vue-editor
- Owner: nhn
- License: mit
- Archived: true
- Created: 2018-09-20T07:15:58.000Z (over 6 years ago)
- Default Branch: master
- Last Pushed: 2020-04-06T01:40:15.000Z (almost 5 years ago)
- Last Synced: 2024-06-22T05:04:02.433Z (8 months ago)
- Topics: editor, vue
- Language: JavaScript
- Homepage:
- Size: 934 KB
- Stars: 230
- Watchers: 11
- Forks: 49
- Open Issues: 21
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
Awesome Lists containing this project
README
# ⚠️Notice: This repository is deprecated️️️️️
TOAST UI Editor Vue Wrapper has been managed separately from the TOAST UI Editor repository. As a result of the distribution of these issues, we decided to deprecated each wrapper repository and manage repository as a [mono-repo](https://en.wikipedia.org/wiki/Monorepo) from the [TOAST UI Editor repository](https://github.com/nhn/tui.editor).
From now on, please submit issues or contributings related to TOAST UI React Wrapper to [TOAST UI Editor repository](https://github.com/nhn/tui.editor). Thank you🙂.
# TOAST UI Editor for Vue
> This is Vue component wrapping [TOAST UI Editor](https://github.com/nhn/tui.editor).
[](https://vuejs.org/)
[](https://github.com/nhn/toast-ui.vue-editor/releases/latest)
[](https://www.npmjs.com/package/@toast-ui/vue-editor)
[](https://github.com/nhn/toast-ui.vue-editor/blob/master/LICENSE)
[](https://github.com/nhn/toast-ui.vue-editor/issues?q=is%3Aissue+is%3Aopen+label%3A%22help+wanted%22)
[](https://github.com/nhn)
## 🚩 Table of Contents
* [Collect statistics on the use of open source](#collect-statistics-on-the-use-of-open-source)
* [Install](#-install)
* [Using npm](#using-npm)
* [Editor Usage](#-editor-usage)
* [Load](#load)
* [Implement](#implement)
* [Using v-model](#using-v-model)
* [Props](#props)
* [Event](#event)
* [Method](#method)
* [Viewer Usage](#-viewer-usage)
* [Load](#load-1)
* [Implement](#implement-1)
* [Props](#props-1)
* [Event](#event-1)
* [Pull Request Steps](#-pull-request-steps)
* [Documents](#-documents)
* [Contributing](#-contributing)
* [License](#-license)
## Collect statistics on the use of open source
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 compoent.
```js
var options = {
...
usageStatistics: false
}
```
Or, include include `tui-code-snippet.js` (**v1.4.0** or **later**) and then immediately write the options as follows:
```js
tui.usageStatistics = false;
```
## 💾 Install
### Using npm
```sh
npm install --save @toast-ui/vue-editor
```
## 📝 Editor Usage
### Load
You can use Toast UI Editor for Vue as moudule format or namespace. Also you can use Single File Component (SFC of Vue). When using module format and SFC, you should load `tui-editor.css`, `tui-editor-contents.css` and `codemirror.css` in the script.
* Using Ecmascript module
```js
import 'tui-editor/dist/tui-editor.css';
import 'tui-editor/dist/tui-editor-contents.css';
import 'codemirror/lib/codemirror.css';
import { Editor } from '@toast-ui/vue-editor'
```
* Using Commonjs module
```js
require('tui-editor/dist/tui-editor.css');
require('tui-editor/dist/tui-editor-contents.css');
require('codemirror/lib/codemirror.css');
var toastui = require('@toast-ui/vue-editor');
var Editor = toastui.Editor;
```
* Using Single File Component
```js
import 'tui-editor/dist/tui-editor.css';
import 'tui-editor/dist/tui-editor-contents.css';
import 'codemirror/lib/codemirror.css';
import Editor from '@toast-ui/vue-editor/src/Editor.vue'
```
* Using namespace
```js
var Editor = toastui.Editor;
```
### Implement
First implement `` in the template.
```html
```
And then add `Editor` to the `components` in your component or Vue instance like this:
```js
import { Editor } from '@toast-ui/vue-editor'
export default {
components: {
'editor': Editor
}
}
```
or
```js
import { Editor } from '@toast-ui/vue-editor'
new Vue({
el: '#app',
components: {
'editor': Editor
}
});
```
### Using v-model
If you use v-model, you have to declare a `data` for binding. (❗️ When using the editor in `wysiwyg` mode, `v-model` can cause performance degradation.)
In the example below, `editorText` is binding to the text of the editor.
```html
import { Editor } from '@toast-ui/vue-editor'
export default {
components: {
'editor': Editor
},
data() {
return {
editorText: ''
}
}
}
```
### Props
| Name | Type | Default | Description |
| --- | --- | --- | --- |
| value | String | '' | This prop can change content of the editor. **If you using `v-model`, don't use it**. |
| 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 | 'tab' | This prop can change preview style of the editor. (`tab` or `vertical`) |
| mode | String | 'markdown' | This prop can change mode of the editor. (`markdown`or `wysiwyg`) |
| html | String | - | If you want to change content of the editor using html format, use this prop. |
| visible | Boolean | true | This prop can control visible of the eiditor. |
```js
const defaultOptions = {
minHeight: '200px',
language: 'en_US',
useCommandShortcut: true,
useDefaultHTMLSanitizer: true,
usageStatistics: true,
hideModeSwitch: false,
toolbarItems: [
'heading',
'bold',
'italic',
'strike',
'divider',
'hr',
'quote',
'divider',
'ul',
'ol',
'task',
'indent',
'outdent',
'divider',
'table',
'image',
'link',
'divider',
'code',
'codeblock'
]
};
```
Example :
``` html
import { Editor } from '@toast-ui/vue-editor'
export default {
components: {
'editor': Editor
},
data() {
return {
editorText: 'This is initialValue.',
editorOptions: {
hideModeSwitch: true
},
editorHtml: '',
editorVisible: true
};
},
};
```
### Event
* load : It would be emitted when editor fully load
* change : It would be emitted when content changed
* stateChange : It would be emitted when format change by cursor position
* focus : It would be emitted when editor get focus
* blur : It would be emitted when editor loose focus
Example :
```html
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
},
onEditorStateChange() {
// implement your code
},
}
};
```
### Method
If you want to more manipulate the Editor, you can use `invoke` method to call the method of tui.editor. For more information of method, see [method of tui.editor](http://nhn.github.io/tui.editor/api/latest/ToastUIEditor.html).
First, you need to assign `ref` attribute of `` and then you can use `invoke` method through `this.$refs` like this:
```html
import { Editor } from '@toast-ui/vue-editor'
export default {
components: {
'editor': Editor
},
methods: {
scroll() {
this.$refs.tuiEditor.invoke('scrollTop', 10);
},
moveTop() {
this.$refs.tuiEditor.invoke('moveCursorToStart');
},
getHtml() {
let html = this.$refs.tuiEditor.invoke('getHtml');
}
}
};
```
## 📃 Viewer Usage
### Load
* Using Ecmascript module
```js
import 'tui-editor/dist/tui-editor-contents.css';
import 'highlight.js/styles/github.css';
import { Viewer } from '@toast-ui/vue-editor'
```
* Using Commonjs module
```js
require('tui-editor/dist/tui-editor-contents.css');
require('highlight.js/styles/github.css');
var toastui = require('@toast-ui/vue-editor');
var Viewer = toastui.Viewer;
```
* Using Single File Component
```js
import 'tui-editor/dist/tui-editor-contents.css';
import 'highlight.js/styles/github.css';
import Viewer from '@toast-ui/vue-editor/src/Viewer.vue'
```
* Using namespace
```js
var Viewer = toastui.Viewer;
```
### Implement
First implement `` in the template.
```html
```
And then add `Viewer` to the `components` in your component or Vue instance like this:
```js
import { Viewer } from '@toast-ui/vue-editor'
export default {
components: {
'viewer': Viewer
}
}
```
or
```js
import { Viewer } from '@toast-ui/vue-editor'
new Vue({
el: '#app',
components: {
'viewer': Viewer
}
});
```
### Props
| Name | Type | Default | Description |
| --- | --- | --- | --- |
| value | String | '' | This prop can change content of the viewer. |
| height | String | '300px' | This prop can control the height of the viewer. |
| exts | Array | | This prop can apply the extensions of the viewer. |
Example :
``` html
import { Viewer } from '@toast-ui/vue-editor'
export default {
components: {
'viewer': Viewer
},
data() {
return {
viewerText: '# This is Viewer.\n Hello World.',
};
},
};
```
### Event
* load : It would be emitted when editor fully load
* change : It would be emitted when content changed
* stateChange : It would be emitted when format change by cursor position
* focus : It would be emitted when editor get focus
* blur : It would be emitted when editor loose focus
Example :
```html
import { Viewer } from '@toast-ui/vue-editor'
export default {
components: {
'viewer': Viewer
},
methods: {
onEditorLoad() {
// implement your code
},
onEditorFocus() {
// implement your code
},
onEditorBlur() {
// implement your code
},
onEditorChange() {
// implement your code
},
onEditorStateChange() {
// implement your code
},
}
};
```
## 🔧 Pull Request Steps
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.
### Setup
Fork `develop` branch into your personal repository.
Clone it to local computer. Install node modules.
Before starting development, you should check to haveany errors.
``` sh
$ git clone https://github.com/{your-personal-repo}/[[repo name]].git
$ cd [[repo name]]
$ npm install
```
### Develop
Let's start development!
### Pull Request
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.
## 💬 Contributing
* [Code of Conduct](https://github.com/nhn/toast-ui.vue-editor/blob/master/CODE_OF_CONDUCT.md)
* [Contributing guideline](https://github.com/nhn/toast-ui.vue-editor/blob/master/CONTRIBUTING.md)
* [Commit convention](https://github.com/nhn/toast-ui.vue-editor/blob/master/docs/COMMIT_MESSAGE_CONVENTION.md)
## 📜 License
This software is licensed under the [MIT](https://github.com/nhn/toast-ui.vue-editor/blob/master/LICENSE) © [NHN.](https://github.com/nhn)