A WYSIWYG rich-text editor using [tiptap](https://github.com/ueberdosis/tiptap) and [Element Plus](https://github.com/element-plus/element-plus) for Vue3
that's easy to use, friendly to developers, fully extensible and clean in design.
It' s version of alpha tiptap 2.0.1 with fixed bugs and repaire previous functionality. Also deleted most warns in console while using.
It' s final version of lib i fixed all bugs, which i saw, welcome issues if you found bugs or warnings, i will try to fix it.
I only done fix bugs and corrected some extentions and delete warnings [original](https://github.com/Leecason/element-tiptap)
if you are Russian company you can refer me job (okijhhyu@gmail.com)
English
## 🎄 Demo
👾[Code Sandbox](https://codesandbox.io/s/element-tiptapt-vue3-element-plus-7xw4pf?file=/src/)
## ✨ Features
- 🎨Use [element-plus](https://github.com/element-plus/element-plus) components
- 💅Many out of box [extensions](https://github.com/okijhhyu/element-tiptap-vue3#extensions) (welcome to submit an issue for feature request👏)
- 🔖Markdown support
- 📘TypeScript support
- 🌐I18n support(`en`, `zh`, `pl`, `ru`, `de`, `ko`, `es`, `zh_tw`, `fr`, `pt_br`, `nl`, `he`). welcome to contribute more languages
- 🎈Events you might use: `create`, `transaction`, `focus`, `blur`, `destroy`
- 🍀Fully extensible, you can customize editor extension and its menu button view
- 💻Also can control the behavior of the editor directly, customize the editor for yourself.
## 📦 Installation
### NPM
```shell
npm i element-tiptap-vue3-fixed
```
#### Install plugin
```js
import { createApp } from 'vue';
import App from './App.vue';
import ElementPlus from 'element-plus';
import ElementTiptapPlugin from 'element-tiptap-vue3-fixed';
// import ElementTiptap's styles
import 'element-tiptap-vue3-fixed/lib/style.css';
const app = createApp(App);
// use ElementPlus's plugin
app.use(ElementPlus);
// use this package's plugin
app.use(ElementTiptapPlugin);
// Now you register `'el-tiptap'` component globally.
app.mount('#app');
```
_Or_
#### Partial import
```vue
```
## 🚀 Usage
```vue
```
## 📔 Props
### extensions
Type: `Array`
You can use the necessary extensions. The corresponding command-buttons will be added by declaring the order of the extension.
All available extensions:
- `Doc`
- `Text`
- `Paragraph`
- `Heading`
- `Bold`
- `Italic`
- `Strike`
- `Underline`
- `Link`
- `Image`
- `Iframe`
- `CodeBlock`
- `Blockquote`
- `BulletList`
- `OrderedList`
- `TaskList`
- `TextAlign`
- `Indent`
- `LineHeight`
- `HorizontalRule`
- `HardBreak`
- `History`
- `Table`
- `FormatClear`
- `Color`
- `Highlight`
- `Print`
- `Fullscreen`
- `SelectAll`
- `FontFamily`
- `FontSize`
- `CodeView`
- [`CodeBlockLowlight`](https://tiptap.dev/api/nodes/code-block-lowlight)
- [`Gapcursor`](https://tiptap.dev/api/extensions/gapcursor/)
- [`Dropcursor`](https://tiptap.dev/api/extensions/gapcursor/)
- [`Commands`](https://tiptap.dev/api/utilities/suggestion)
You can find all extensions docs [here](https://github.com/Leecason/element-tiptap/issues/107).
### Addendum to the link above
Extension: `Commands`
Usage
```Vue
import {
...
Commands,
getSuggestionItems,
renderItems
} from 'element-tiptap-vue3-fixed';
Commands.configure({
suggestion: {
items: getSuggestionItems,
render: renderItems
}
}),
```
Extension: `All`
Custom svg for extensions
```Vue
Image.configure({
buttonIcon: ''
})
```
for (Indent, History) ['swg', 'swg']
for (TextAlign) ['swg', 'swg', 'swg', 'swg']
.. pull-quote::
**Warning**
**NB:** Although the buttonIcon attribute supports incoming HTML fragments, it is very dangerous to dynamically render arbitrary HTML on the website, because it is easy to cause XSS attack. Please make sure that the content of buttonIcon is trustworthy. Never assign user-submitted content to the buttonIcon attribute.
Extention: `Image`
Insert images with original width
```vue
Image.configure({
defaultWidth: null
})
```
Insert images with width: 400px
```vue
Image.configure({
defaultWidth: 400
})
```
Dragging images (tests)
adding button which allow to move images
```vue
Image.configure({
draggable: true
})
```
Extention: `Link`
placeholder
```vue
Link.configure({
addLinkPlaceholder: 'add link', // placeholder for adding link
editLinkPlaceholder: 'edit link' // placeholder for editing link
}),
You can customize the extension. See [Custom extensions](https://tiptap.dev/guide/custom-extensions).
### Example custom extension
```vue
import CodeBlockLowlight from '@tiptap/extension-code-block-lowlight';
import {
Editor
} from '@tiptap/core';
import { CommandButton } from 'element-tiptap-vue3-fixed';
export default CodeBlockLowlight.extend({
addOptions() {
return {
...this.parent?.(),
button({ editor, t }: { editor: Editor; t: (...args: any[]) => string }) {
return {
component: CommandButton, // component of button which is used in menubar or bubblemenu (u can write your own component of button)
componentProps: { // props is used in component
command: () => { // command on click button
editor.commands.toggleCodeBlock();
},
// WARNING buttonIcon attribute supports incoming HTML fragments, it is very dangerous to dynamically render arbitrary HTML on the website, because it is easy to cause XSS attack.
buttonIcon: '', // your custom svg, if there is not uses default
isActive: editor.isActive('codeBlock'),
icon: 'code', // name of element-tiptap icon (don't customized)
tooltip: t('editor.extensions.CodeBlock.tooltip'),
},
};
},
};
},
});
```
### setContent
```html
```
```vue
this.$refs.editor.setContent(Content);
can do reactive, but history brokes so add this function, to change content if necessary.
```
### placeholder
Type: `string`
Default: `''`
When editor is empty, placeholder will display.
```html
```
### content
Type: `object` for output json
Default: `''`
Type: `string` for output html
Default: `''`
Editor's content
```html
```
or Use `'v-model'`
```html
```
### output
Type: `string`
Default: `'html'`
Output can be defined to `'html'` or `'json'`.
```html
```
further reading: [prosemirror data structure](https://prosemirror.net/docs/guide/#doc)
### readonly
Type: `boolean`
Default: `false`
```html
```
when `readonly` is `true`, editor is not editable.
### spellcheck
Type: `boolean`
Default: `false`
```html
```
Whether the content is spellcheck enabled.
### editorProps
Type: `Object`
Default: `{}`
```html
```
about [editorProps](https://prosemirror.net/docs/ref/#view.EditorProps)
### width, height
Type: `string | number`
A string value with unit or a simple value (the default unit is **`px`**)：
```html
```
The above example will be converted to:
```css
width: 700px;
height: 100%;
```
### enableCharCount
Type: `boolean`
Default: `true`
Enables or disables the display of the character counter.
### tooltip
Type: `boolean`
Default: `true`
Control if tooltips are shown when getting with mouse over the buttons from the toolbar.
### locale
Specifies the editor i18n language.
```js
```
Available languages:
- `en`(default)
- `zh`
- `pl` by @FurtakM
- `ru` by @baitkul
- `de` by @Thesicstar
- `ko` by @Hotbrains
- `es` by @koas
- `zh_tw` by @eric0324
- `fr` by @LPABelgium
- `pt_br` by @valterleonardo
- `nl` by @Arne-Jan
- `he` by @shovalPMS
Welcome contribution.
## 👽 Events
### onCreate
```vue
```
### onTransaction, onFocus, onBlur, onDestroy
The same as `onCreate`
## 🏗 Contributing
Please see [CONTRIBUTING](CONTRIBUTING.md) for details.
## 📄 License
[MIT](https://github.com/okijhhyu/element-tiptap-vue3/blob/dev/LICENSE)
