Directory

← Back

vcf-enhanced-rich-text-editor

Extended version of Vaadin Rich Text

Author

Rating

Popularity

<100

Usage

VCF Enhanced Rich Text Editor for Flow is an extended version of Vaadin Rich Text Editor with more functionalities like tab-stops, non-breaking space, rulers, customizing toolbar buttons and read-only sections.

##Tabstops can be set in UI by clicking on horizontal ruler, on top of the editor. There are 3 tabstop possible directions: Left, Right and Middle.

  • When Direction set to Left: then left side of text will be aligned to right side of tab stop (>text)
  • When Direction set to Right: then right side of text will be aligned to left side of tab stop (text<)
  • When Direction set to Middle: then text will be centered to tab stop (te|xt)

When you click on ruler left tabstop will appear, then if you click on left tabstop it will change to right tabstop, and if you click on right tabstop it will change to middle tabstop. It is also possible to set tabstops programmatically by using tabStops property of editor.

Non-breaking space

To add a non-breaking space where the caret is located, press shift+space.

Customizing toolbar buttons

You can use setToolbarButtonsVisibility to show/hide the toolbar buttons. For example, the following piece of code hides Image and Link buttons.

Server-side implementation

This is the client-side (Web) component. Looking for the server-side version? It can be found here: https://vaadin.com/directory/component/enhanced-rich-text-editor

Vaadin Prime

This component is available in of Vaadin Prime subscription. It is still open source, but you need to have a valid CVAL license in order to use it. Read more at: https://vaadin.com/pricing

Sample code

<vcf-enhanced-rich-text-editor></vcf-enhanced-rich-text-editor>
editor.tabStops = [{direction: 'left', position: 150}, {direction: 'middle', position: 350}, {direction: 'right', position: 500}];
<vcf-enhanced-rich-text-editor></vcf-enhanced-rich-text-editor>
<script>
  window.addEventListener('WebComponentsReady', function() {
    var rte = document.querySelector("vcf-enhanced-rich-text-editor");
    rte.toolbarButtons = {undo: false, redo: false, h1: false, h2: false, h3: false, image: false, link: false};
  });
</script>

Compatibility

(Loading compatibility data...)

Was this helpful? Need more help?
Leave a comment or a question below. You can also join the chat on Discord or ask questions on StackOverflow.

Version

Dependencies

  • polymer#^2.0.0
  • vaadin-themable-mixin#vaadin/vaadin-themable-mixin#^1.2.0
  • vaadin-element-mixin#vaadin/vaadin-element-mixin#^2.0.0
  • vaadin-button#vaadin/vaadin-button#^2.1.0
  • vaadin-confirm-dialog#vaadin/vaadin-confirm-dialog#^1.1.0
  • vaadin-text-field#vaadin/vaadin-text-field#^2.1.0
  • vaadin-license-checker#vaadin/license-checker#^2.1.0
  • vaadin-lumo-styles#vaadin/vaadin-lumo-styles#^1.3.0
  • vaadin-material-styles#vaadin/vaadin-material-styles#^1.2.0
  • vaadin-icons#vaadin/vaadin-icons#^4.3.1
Released
2019-06-25
Maturity
IMPORTED
License
Other

Compatibility

Framework
Polymer 2.0+
Polymer 3.0+ in 1.2.0
Browser
Browser Independent

Vaadin Add-on Directory

Find open-source widgets, add-ons, themes, and integrations for your Vaadin application. Vaadin Add-on Directory
The channel for finding, promoting, and distributing Vaadin add-ons.
Online