vaadin-rich-text-editor

Web Component for rich text input. Part of the Vaadin components. https://vaadin.com/components

<vaadin-rich-text-editor>

Live Demo ↗ | API documentation ↗

<vaadin-rich-text-editor> is a Web Component providing rich text editor functionality, part of the Vaadin components.

<vaadin-rich-text-editor>
  ...
</vaadin-rich-text-editor>

Installation

The Vaadin components are distributed as Bower and npm packages. Please note that the version range is the same, as the API has not changed. You should not mix Bower and npm versions in the same application, though.

Unlike the official Polymer Elements, the converted Polymer 3 compatible Vaadin components are only published on npm, not pushed to GitHub repositories.

Polymer 2 and HTML Imports compatible version

Install vaadin-rich-text-editor:

bower i vaadin/vaadin-rich-text-editor --save

Once installed, import it in your application:

<link rel="import" href="bower_components/vaadin-rich-text-editor/vaadin-rich-text-editor.html">

Polymer 3 and ES Modules compatible version

Install vaadin-rich-text-editor:

npm i @vaadin/vaadin-rich-text-editor --save

Once installed, import it in your application:

import '@vaadin/vaadin-rich-text-editor/vaadin-rich-text-editor.js';

Bundling with webpack

When using webpack to bundle the application, do the following steps:

1. Install the loader:

npm install expose-loader --save-dev

2. Add these lines to the webpack config:

module: {
  rules: [
  ...
  {
    test: require.resolve('@vaadin/vaadin-rich-text-editor/vendor/vaadin-quill.js'),
    use: [{
      loader: 'expose-loader',
      options: 'Quill'
    }]
  }

Getting started

Vaadin components use the Lumo theme by default.

To use the Material theme, import the correspondent file from the theme/material folder.

Entry points

• The component with the Lumo theme:

  theme/lumo/vaadin-rich-text-editor.html

• The component with the Material theme:

  theme/material/vaadin-rich-text-editor.html

• Alias for theme/lumo/vaadin-rich-text-editor.html:

  vaadin-rich-text-editor.html

Running demos and tests in a browser

1. Fork the vaadin-rich-text-editor repository and clone it locally.

2. Make sure you have npm and Bower installed.

3. When in the vaadin-rich-text-editor directory, run npm install and then bower install to install dependencies.

4. Make sure you have polymer-cli installed globally: npm i -g polymer-cli.

5. Run npm start, browser will automatically open the component API documentation.

6. You can also open demo or in-browser tests by adding demo or test to the URL, for example:

• http://127.0.0.1:3000/components/vaadin-rich-text-editor/demo
• http://127.0.0.1:3000/components/vaadin-rich-text-editor/test

Running tests from the command line

1. When in the vaadin-rich-text-editor directory, run polymer test

Following the coding style

We are using ESLint for linting JavaScript code. You can check if your code is following our standards by running gulp lint, which will automatically lint all .js files as well as JavaScript snippets inside .html files.

Big Thanks

Cross-browser Testing Platform and Open Source <3 Provided by Sauce Labs.

Contributing

To contribute to the component, please read the guideline first.

License

Commercial Vaadin Add-on License version 3 (CVALv3). For license terms, see LICENSE.

Vaadin collects development time usage statistics to improve this product. For details and to opt-out, see https://github.com/vaadin/vaadin-usage-statistics.

Links

• Issue tracker
• View on NPM
• GitHub Homepage
• View on GitHub

Compatibility