Giter VIP home page Giter VIP logo

quill-editor's Introduction

Quill RichText Editor

A RichText Editor component for Vaadin Flow using the open source Quill Editor library

Install

Add the quill-editor dependency to your pom.xml:

<dependency>
   <groupId>org.vaadin.klaudeta</groupId>
   <artifactId>quill-editor</artifactId>
   <version>1.0.0</version>
</dependency>

Do not forget to add the vaadin-addons repository:

<repository>
   <id>vaadin-addons</id>
   <url>http://maven.vaadin.com/vaadin-addons</url>
</repository>

Basic Usage

Create a QuillEditor and configure the toolbar. Define which toolbar commands should be removed. The default behaviour is that the toolbar will contain all available commands.

    QuillEditor quillEditor = new QuillEditor();
    quillEditor.getToolbarConfigurator()
        .noFontDecorators()
        .noColors()
        .initEditor();

    quillEditor.setSizeFull();
    layout.add(quillEditor);

Binding the QuillEditor to a Binder instance. QuillEditor extends the com.vaadin.flow.component.AbstractCompositeField class so it is possible to bind it to a Binder as with all the other Vaadin components which extend the HasValue interface.

    QuillEditor quillEditor = new QuillEditor();
    Binder<Bean> beanBinder = new Binder<>();
    
    beanBinder
        .forField(quillEditor)
        .asRequired("Content is mandatory")
        .bind(Bean::getContent, Bean::setContent);

Branching information

  • master the latest version of the component, using latest stable platform version
  • v14 the version for Vaadin 14, which is the newest LTS

Running demos locally

  1. Fork the quill-editor repository and clone it locally.
  2. Build the project: mvn clean install
  3. Start the test/demo server: mvn jetty:run
  4. Navigate to http://localhost:8080 to view the demo.

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.