Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/chuckh/polymer-quill
Polymer Quill Rich Text Editor
https://github.com/chuckh/polymer-quill
bubble-theme delta demo medium polymer-quill snow-theme webcomponents
Last synced: about 1 month ago
JSON representation
Polymer Quill Rich Text Editor
- Host: GitHub
- URL: https://github.com/chuckh/polymer-quill
- Owner: chuckh
- Created: 2016-09-14T01:35:10.000Z (about 8 years ago)
- Default Branch: master
- Last Pushed: 2023-01-12T08:55:04.000Z (almost 2 years ago)
- Last Synced: 2024-10-22T15:36:47.639Z (about 2 months ago)
- Topics: bubble-theme, delta, demo, medium, polymer-quill, snow-theme, webcomponents
- Language: HTML
- Size: 4.12 MB
- Stars: 51
- Watchers: 5
- Forks: 29
- Open Issues: 16
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
- awesome-quill - polymer-quill - Polymer Quill Rich Text Editor (Uncategorized / Uncategorized)
README
[](https://beta.webcomponents.org/element/PolymerElements/paper-button)
[](https://travis-ci.org/chuckh/polymer-quill)
# \
## Polymer Quill Rich Text Editor
- `` element creates a Polymer Quill Rich Text Editor using the Snow Theme.
- `` element creates a Polymer Quill Rich Text Editor using the Bubble Theme (popup toolbar like Medium).
- `` element creates a Polymer Quill HTML Render
Quill is a free, open source WYSIWYG editor built for the modern web.
With its modular architecture and expressive API, it is completely customizable to fit any need.
Learn more at http://quilljs.com/
### Screenshot Snow Theme
```html
```
## Demo and API docs
If your are viewing this from webcomponents.org, use the below links for API and demos, not the links on right sidebar.
- [API docs](https://chuckh.github.io/polymer-quill/#polymer-quill)
- [Demo Snow Toolbar](https://chuckh.github.io/polymer-quill/components/polymer-quill/demo/)
- [Demo Bubble Toolbar (Medium style)](https://chuckh.github.io/polymer-quill/components/polymer-quill/demo/bubble.html)
- [Demo Quill HTML Render](https://chuckh.github.io/polymer-quill/components/polymer-quill/demo/html-render.html)
### Examples
#### Defaults (stores as Deltas every 2 seconds, does not show results, 50px height)
#### Defaults (stores as Deltas every 2 seconds, does not show results, 50px height)
#### Custom (stores as HTML every 5 seconds, show results)
#### Custom (stores as HTML every 5 seconds, show results)
Hello World">
#### Demo example
```html
polymer-quill.full {
--polymer-quill-editor-max-height: 300px;
--polymer-quill-editor-min-height: 100px;
}
Full Toolbar, Show Results, Max Height (300px), Min Height (100px), Save as Deltas, Save every 1 second
Standard Toolbar, Hide Results, Default height (100px), Save as HTML, Save every 2 seconds
```
## Styling
The following custom properties and mixins are available for styling. This allows the editor auto grow to the max-height.:
### polymer-quill (Snow theme)
Also had to make editor have `padding-bottom: 50px` to have link popup show.
Custom property | Description | Default
----------------|-------------|----------
`--polymer-quill-editor-max-height` | Custom max-height for editor | `400px`
`--polymer-quill-editor-min-height` | Custom max-height for editor | `50px`
`--polymer-quill-editor-overflow` | Custom overflow for editor | `scroll`
`--polymer-quill-editor-border` | Custom min-height for editor | `solid 1px #ccc`
`--polymer-quill` | Mixin applied to the editor | `{}`
Below is example of setting the editor to `max-height` of 260px less then the viewport height and `min-height` of 150px. So any content greater then the max-height with scroll otherwise it will auto grow.
```
polymer-quill {
--polymer-quill-editor-max-height: calc(100vh - 260px);
--polymer-quill-editor-min-height: 150px;
max-width: 870px;
box-shadow: 0 2px 2px 0 rgba(0, 0, 0, 0.14), 0 1px 5px 0 rgba(0, 0, 0, 0.12), 0 3px 1px -2px rgba(0, 0, 0, 0.2);
padding: 0;
margin-left: auto;
margin-bottom: 5px;
margin-right: auto;
border-radius: 5px;
background-color: #fff;
color: #212121;
}
```
### polymer-quill-bubble (Bubble theme)
Max-height needs to be set for bubble popup toolbar to work with is default.
Also had to make editor have `padding-bottom: 50px` so toolbar displays for last line.
Custom property | Description | Default
----------------|-------------|----------
`--polymer-quill-editor-max-height` | Custom max-height for editor | `auto`
`--polymer-quill-editor-min-height` | Custom min-height for editor | `50px`
`--polymer-quill-editor-overflow` | Custom overflow for editor | `scroll`
`--polymer-quill-editor-border` | Custom min-height for editor | `solid 1px #ccc`
`--polymer-quill` | Mixin applied to the editor | `{}`
## Install
bower install --save polymer-quill
### Polymer Starter Kit 2
If you are using Polymer Starter Kit 2 or like as the bases of your app you will need to change `dom: 'shadow'` to `dom: 'shady'` like below. Otherwise the Polymer Quill Editor will not display.
```javascript
// Setup Polymer options
window.Polymer = {
dom: 'shady',
lazyRegister: true
};
```
## License
### The MIT License (MIT)
Copyright (c) 2016 Chuck Horton
Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
