reagent-quill

KO | EN

gitlite — search

#javascript #python #hacktoberfest #react #ai #typescript #llm #go #golang #android #machine-learning #rust #deep-learning #linux

★ 15 Open GitHub ↗

Basic reagent recipe for quill rich text editor

// repository documentation

Was this content helpful?

★ 0 (0 ratings)

# reagent-quill
Basic [reagent](http://reagent-project.github.io/) recipe for [Quill rich text editor](http://quilljs.com/)

See the [Quill documentation](http://quilljs.com/docs/quickstart/) for a full rundown of what's possible. Note that the toolbar can have many more functions including your own custom stuff. Also note that this example deals with only HTML and therefore does not use [deltas](https://quilljs.com/guides/designing-the-delta-format/) and as such does no delta <-> HTML conversion. I have built these particular examples to both create text and display text (so for just displaying text, building an editor without a toolbar is as straight forward as it sounds). These recipes provide clear enough templates to riff on.

## Usage

Add the css theme file (adjusting paths to suit) to the head of your file
```cljs
[:head
 ;; other head stuff ...
 (include-css "/quill/css/quill.snow.css")]
```

Add the cljsjs dependency
```cljs
[cljsjs/quill "1.1.0-3"]
```

reagent-quill/editor takes the following parameters:
 * `id` (string): a unique id to associate with the editor and toolbar of your quill component
 * `content` (string | html): the content to display
 * `selection` (vector [start-index finish-index] | nil): the text to select
 * `on-change-fn` (function): the function to call when editor text changes

Make sure to require cljsjs.quill somewhere in your project so it is added to your compiled ClojureScript code. I put all my cljsjs deps in core.cljs but it really doesn't matter. Note: you need only reference the cljsjs.quill dep once and it'll be available everywhere in your project.

In your reagent app, use the editor like so:
```cljs
(ns your.component.or.view
  (:require
   [quill :as quill]))
   
   [:div
    [quill/editor
    {:id "my-quill-editor-component-id"
     :content "welcome to reagent-quill!"
     :selection nil
     :on-change-fn #(if (= % "user")
                      (println (str "text changed: " %2))}]]
```

reagent-quill/display-area takes the following parameters:
 * `id` (string): a unique id to associate with the editor and toolbar of your quill component
 * `content` (string | html): the content to display
 
In your reagent app, use the display-area like so:
```cljs
(ns your.component.or.view
  (:require
   [quill :as quill]))
   
   [:div
    [quill/display-area
    {:id "my-quill-display-area-component-id"
     :content "welcome to reagent-quill!"}]]

reagent-quill

Explore Similar Repositories

Was this content helpful?

Recent Feedback

Download README