JarCasting
JarCasting JarCasting

incubator-rich-text-editor

WebJar for incubator-rich-text-editor

License

License
Categories

Categories

Vaadin User Interface Web Frameworks Github Development Tools Version Controls
GroupId

GroupId

org.webjars.bower
ArtifactId

ArtifactId

github-com-vaadin-incubator-rich-text-editor
Last Version

Last Version

0.0.0
Release Date

Release Date
Type

Type

jar
Description

Description

incubator-rich-text-editor
WebJar for incubator-rich-text-editor
Project URL

Project URL

http://webjars.org
Source Code Management

Source Code Management

https://github.com/vaadin/incubator-rich-text-editor

Download github-com-vaadin-incubator-rich-text-editor

Filename Size
github-com-vaadin-incubator-rich-text-editor-0.0.0.pom
github-com-vaadin-incubator-rich-text-editor-0.0.0.jar 472 KB
github-com-vaadin-incubator-rich-text-editor-0.0.0-sources.jar 22 bytes
github-com-vaadin-incubator-rich-text-editor-0.0.0-javadoc.jar 22 bytes
Browse

How to add to project

<!-- https://jarcasting.com/artifacts/org.webjars.bower/github-com-vaadin-incubator-rich-text-editor/ -->
<dependency>
    <groupId>org.webjars.bower</groupId>
    <artifactId>github-com-vaadin-incubator-rich-text-editor</artifactId>
    <version>0.0.0</version>
</dependency>
// https://jarcasting.com/artifacts/org.webjars.bower/github-com-vaadin-incubator-rich-text-editor/
implementation 'org.webjars.bower:github-com-vaadin-incubator-rich-text-editor:0.0.0'
// https://jarcasting.com/artifacts/org.webjars.bower/github-com-vaadin-incubator-rich-text-editor/
implementation ("org.webjars.bower:github-com-vaadin-incubator-rich-text-editor:0.0.0")
'org.webjars.bower:github-com-vaadin-incubator-rich-text-editor:jar:0.0.0'
<dependency org="org.webjars.bower" name="github-com-vaadin-incubator-rich-text-editor" rev="0.0.0">
  <artifact name="github-com-vaadin-incubator-rich-text-editor" type="jar" />
</dependency>
@Grapes(
@Grab(group='org.webjars.bower', module='github-com-vaadin-incubator-rich-text-editor', version='0.0.0')
)
libraryDependencies += "org.webjars.bower" % "github-com-vaadin-incubator-rich-text-editor" % "0.0.0"
[org.webjars.bower/github-com-vaadin-incubator-rich-text-editor "0.0.0"]

Dependencies

compile (9)

Group / Artifact Type Version
org.webjars.bower : github-com-vaadin-vaadin-text-field jar [2.1.0,3)
org.webjars.bower » github-com-vaadin-vaadin-material-styles jar [1.2.0,2)
org.webjars.bower : github-com-vaadin-vaadin-element-mixin jar [2.0.0,3)
org.webjars.bower : polymer jar [2.0.0,3)
org.webjars.bower : github-com-vaadin-vaadin-button jar [2.1.0,3)
org.webjars.bower : github-com-vaadin-vaadin-lumo-styles jar [1.3.0,2)
org.webjars.bower : github-com-vaadin-license-checker jar [2.1.0,3)
org.webjars.bower » github-com-vaadin-vaadin-confirm-dialog jar [1.1.0,2)
org.webjars.bower : github-com-vaadin-vaadin-themable-mixin jar [1.2.0,2)

Project Modules

There are no modules declared in this project.

npm version Bower version Published on webcomponents.org Build Status Coverage Status Gitter

Published on Vaadin Directory Stars on vaadin.com/directory

<incubator-rich-text-editor>

Live Demo ↗ | API documentation ↗

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

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

Screenshot of incubator-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 incubator-rich-text-editor:

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

Once installed, import it in your application:

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

Polymer 3 and ES Modules compatible version

Install incubator-rich-text-editor:

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

Once installed, import it in your application:

import '@vaadin/incubator-rich-text-editor/incubator-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
  1. Add these lines to the webpack config:
module: {
  rules: [
  ...
  {
    test: require.resolve('@vaadin/incubator-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/incubator-rich-text-editor.html

  • The component with the Material theme:

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

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

    incubator-rich-text-editor.html

Running demos and tests in a browser

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

  2. Make sure you have npm and Bower installed.

  3. When in the incubator-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:

Running tests from the command line

  1. When in the incubator-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 npm run 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.

org.webjars.bower

Vaadin

An open platform for building modern web apps for Java back ends

Versions

Version
0.0.0