Keyboard support in Vue Rich text editor component
17 Mar 202320 minutes to read
The editor has full keyboard accessibility that includes shortcuts to open and other actions with toolbar items, drop-down lists, and dialogs.
HTML formation shortcut key
You can use the following key shortcuts when the Rich Text Editor renders with HTML
editMode
.
Actions | Keyboard shortcuts |
---|---|
Toolbar focus | alt + f10 |
Insert link | ctrl + k |
Insert image | ctrl + shift + i |
Insert table | ctrl + shift + e |
Undo | ctrl + z |
Redo | ctrl + y |
Copy | ctrl + c |
Cut | ctrl + x |
Paste | ctrl + v |
Bold | ctrl + b |
Italic | ctrl + i |
Underline | ctrl + u |
Strikethrough | ctrl + shift + s |
Uppercase | ctrl + shift + u |
Lowercase | ctrl + shift + l |
Superscript | ctrl + shift + = |
Subscript | ctrl + = |
Indents | ctrl + ] |
Outdents | ctrl + [ |
HTML source | ctrl + shift + h |
Fullscreen | ctrl + shift + f |
Exit Fullscreen | Esc |
Justify center | ctrl + e |
Justify full | ctrl + j |
Justify left | ctrl + l |
Justify right | ctrl + r |
Clear format | ctrl + shift + r |
Ordered list | ctrl + shift + o |
Unordered list | ctrl + alt + o |
<template>
<ejs-richtexteditor ref="defaultRTE" :height="340" :toolbarSettings="toolbarData">
<p>The Rich Text Editor component is WYSIWYG ("what you see is what you get") editor that provides the best user experience to create and update the content. Users can format their content using standard toolbar commands.</p>
<p><b>Key features:</b></p>
<ul>
<li>
<p>Provides IFRAME and DIV modes</p>
</li>
<li>
<p>Capable of handling markdown editing.</p>
</li>
<li>
<p>Contains a modular library to load the necessary functionality on demand.</p>
</li>
<li>
<p>Provides a fully customizable toolbar.</p>
</li>
<li>
<p>Provides HTML view to edit the source directly for developers.</p>
</li>
<li>
<p>Supports third-party library integration.</p>
</li>
<li>
<p>Allows preview of modified content before saving it.</p>
</li>
<li>
<p>Handles images, hyperlinks, video, hyperlinks, uploads, etc.</p>
</li>
</ul>
</ejs-richtexteditor>
</template>
<script>
import Vue from 'vue';
import { RichTextEditorPlugin, Toolbar, Link, Image, HtmlEditor, QuickToolbar } from '@syncfusion/ej2-vue-richtexteditor';
Vue.use(RichTextEditorPlugin);
export default {
data() {
return {
toolbarData: {
items: ['Bold', 'Italic', 'Underline', 'StrikeThrough',
'FontName', 'FontSize', 'FontColor', 'BackgroundColor',
'LowerCase', 'UpperCase', '|',
'Formats', 'Alignments', 'OrderedList', 'UnorderedList',
'Outdent', 'Indent', '|',
'CreateLink', 'Image', '|', 'ClearFormat', 'Print',
'SourceCode', 'FullScreen', '|', 'Undo', 'Redo']
}
}
},
mounted() {
document.addEventListener('keyup', this.onKeyUp);
},
methods: {
onKeyUp (e) {
if (e.altKey && e.keyCode === 84) { /* t */
// press alt+t to focus the component.
this.$refs.defaultRTE.ej2Instances.focusIn();
}
}
},
provide: {
richtexteditor: [Toolbar, Link, Image, HtmlEditor, QuickToolbar]
}
}
</script>
<style>
@import "https://ej2.syncfusion.com/vue/documentation/../node_modules/@syncfusion/ej2-base/styles/material.css";
@import "../../node_modules/@syncfusion/ej2-inputs/styles/material.css";
@import "../../node_modules/@syncfusion/ej2-lists/styles/material.css";
@import "../../node_modules/@syncfusion/ej2-popups/styles/material.css";
@import "../../node_modules/@syncfusion/ej2-buttons/styles/material.css";
@import "../../node_modules/@syncfusion/ej2-navigations/styles/material.css";
@import "../../node_modules/@syncfusion/ej2-splitbuttons/styles/material.css";
@import "../../node_modules/@syncfusion/ej2-vue-richtexteditor/styles/material.css";
</style>
Markdown formation shortcut key
You can use the following key shortcuts when the Rich Text Editor renders with Markdown
editMode.
Actions | Keyboard shortcuts |
---|---|
Toolbar focus | alt + f10 |
Insert link | ctrl + k |
Insert image | ctrl + shift + i |
Insert table | ctrl + shift + e |
Undo | ctrl + z |
Redo | ctrl + y |
Copy | ctrl + c |
Cut | ctrl + x |
Paste | ctrl + v |
Bold | ctrl + b |
Italic | ctrl + i |
Strikethrough | ctrl + shift + s |
Uppercase | ctrl + shift + u |
Lowercase | ctrl + shift + l |
Superscript | ctrl + shift + = |
Subscript | ctrl + = |
Fullscreen | ctrl + shift + f |
Ordered list | ctrl + shift + o |
Unordered list | ctrl + alt + o |
<template>
<ejs-richtexteditor ref="defaultRTE" :height="340" :toolbarSettings="toolbarData" :valueTemplate="valueTemplate" editorMode="Markdown">
<p>The Rich Text Editor component is WYSIWYG ("what you see is what you get") editor that provides the best user experience to create and update the content. Users can format their content using standard toolbar commands.</p>
<p><b>Key features:</b></p>
<ul>
<li>
<p>Provides IFRAME and DIV modes</p>
</li>
<li>
<p>Capable of handling markdown editing.</p>
</li>
<li>
<p>Contains a modular library to load the necessary functionality on demand.</p>
</li>
<li>
<p>Provides a fully customizable toolbar.</p>
</li>
<li>
<p>Provides HTML view to edit the source directly for developers.</p>
</li>
<li>
<p>Supports third-party library integration.</p>
</li>
<li>
<p>Allows preview of modified content before saving it.</p>
</li>
<li>
<p>Handles images, hyperlinks, video, hyperlinks, uploads, etc.</p>
</li>
</ul>
</ejs-richtexteditor>
</template>
<script>
import Vue from 'vue';
import { RichTextEditorPlugin, Toolbar, Link, Image, MarkdownEditor } from '@syncfusion/ej2-vue-richtexteditor';
Vue.use(RichTextEditorPlugin);
export default {
data() {
return {
toolbarData: {
items: ['Bold', 'Italic', 'StrikeThrough', '|',
'Formats', 'OrderedList', 'UnorderedList', '|',
'CreateLink', 'Image', '|','Undo', 'Redo']
},
valueTemplate: `The sample is added to showcase **markdown editing**.
Type or edit the content and apply formatting to view markdown formatted content.
We can add our own custom formation syntax for the Markdown formation, [sample link](https://ej2.syncfusion.com/home/).
The third-party library <b>Marked</b> is used in this sample to convert markdown into HTML content`
}
},
mounted() {
document.addEventListener('keyup', this.onKeyUp);
},
methods: {
onKeyUp (e) {
if (e.altKey && e.keyCode === 84) { /* t */
// press alt+t to focus the component.
this.$refs.defaultRTE.ej2Instances.focusIn();
}
}
},
provide: {
richtexteditor: [Toolbar, Link, Image, MarkdownEditor]
}
}
</script>
<style>
@import "https://ej2.syncfusion.com/vue/documentation/../node_modules/@syncfusion/ej2-base/styles/material.css";
@import "../../node_modules/@syncfusion/ej2-inputs/styles/material.css";
@import "../../node_modules/@syncfusion/ej2-lists/styles/material.css";
@import "../../node_modules/@syncfusion/ej2-popups/styles/material.css";
@import "../../node_modules/@syncfusion/ej2-buttons/styles/material.css";
@import "../../node_modules/@syncfusion/ej2-navigations/styles/material.css";
@import "../../node_modules/@syncfusion/ej2-splitbuttons/styles/material.css";
@import "../../node_modules/@syncfusion/ej2-vue-richtexteditor/styles/material.css";
</style>
Custom key config
Customize the key config for the keyboard interaction of Rich Text Editor, using the keyConfig
property.
In the following sample, customize the cut, copy, paste toolbar action with ctrl+1
, ctrl+2
, ctrl+3
, respectively.
<template>
<ejs-richtexteditor ref="defaultRTE" :height="340" :toolbarSettings="toolbarData" :keyConfigs="keyConfig">
<p>The Rich Text Editor component is WYSIWYG ("what you see is what you get") editor that provides the best user experience to create and update the content. Users can format their content using standard toolbar commands.</p>
<p><b>Key features:</b></p>
<ul>
<li>
<p>Provides IFRAME and DIV modes</p>
</li>
<li>
<p>Capable of handling markdown editing.</p>
</li>
<li>
<p>Contains a modular library to load the necessary functionality on demand.</p>
</li>
<li>
<p>Provides a fully customizable toolbar.</p>
</li>
<li>
<p>Provides HTML view to edit the source directly for developers.</p>
</li>
<li>
<p>Supports third-party library integration.</p>
</li>
<li>
<p>Allows preview of modified content before saving it.</p>
</li>
<li>
<p>Handles images, hyperlinks, video, hyperlinks, uploads, etc.</p>
</li>
</ul>
</ejs-richtexteditor>
</template>
<script>
import Vue from 'vue';
import { RichTextEditorPlugin, Toolbar, Link, Image, HtmlEditor, QuickToolbar } from '@syncfusion/ej2-vue-richtexteditor';
Vue.use(RichTextEditorPlugin);
export default {
data() {
return {
toolbarData: {
items: ['Bold', 'Italic', 'Underline', 'StrikeThrough',
'FontName', 'FontSize', 'FontColor', 'BackgroundColor',
'LowerCase', 'UpperCase', '|',
'Formats', 'Alignments', 'OrderedList', 'UnorderedList',
'Outdent', 'Indent', '|',
'CreateLink', 'Image', '|', 'ClearFormat', 'Print',
'SourceCode', 'FullScreen', '|', 'Undo', 'Redo']
},
keyConfig: {
'copy': 'ctrl+1',
'cut': 'ctrl+2',
'paste': 'ctrl+3'
}
}
},
mounted() {
document.addEventListener('keyup', this.onKeyUp);
},
methods: {
onKeyUp (e) {
if (e.altKey && e.keyCode === 84) { /* t */
// press alt+t to focus the component.
this.$refs.defaultRTE.ej2Instances.focusIn();
}
}
},
provide: {
richtexteditor: [Toolbar, Link, Image, HtmlEditor, QuickToolbar]
}
}
</script>
<style>
@import "../../node_modules/@syncfusion/ej2-base/styles/material.css";
@import "../../node_modules/@syncfusion/ej2-inputs/styles/material.css";
@import "../../node_modules/@syncfusion/ej2-lists/styles/material.css";
@import "../../node_modules/@syncfusion/ej2-popups/styles/material.css";
@import "../../node_modules/@syncfusion/ej2-buttons/styles/material.css";
@import "../../node_modules/@syncfusion/ej2-navigations/styles/material.css";
@import "../../node_modules/@syncfusion/ej2-splitbuttons/styles/material.css";
@import "../../node_modules/@syncfusion/ej2-vue-richtexteditor/styles/material.css";
</style>