{"id":13535642,"url":"https://github.com/chuckh/polymer-quill","last_synced_at":"2025-10-22T21:31:29.523Z","repository":{"id":58236126,"uuid":"68162445","full_name":"chuckh/polymer-quill","owner":"chuckh","description":"Polymer Quill Rich Text Editor","archived":false,"fork":false,"pushed_at":"2023-01-12T08:55:04.000Z","size":4322,"stargazers_count":51,"open_issues_count":16,"forks_count":29,"subscribers_count":4,"default_branch":"master","last_synced_at":"2025-03-22T04:48:04.504Z","etag":null,"topics":["bubble-theme","delta","demo","medium","polymer-quill","snow-theme","webcomponents"],"latest_commit_sha":null,"homepage":null,"language":"HTML","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/chuckh.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":null,"code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2016-09-14T01:35:10.000Z","updated_at":"2024-06-29T15:57:06.000Z","dependencies_parsed_at":"2023-02-09T11:00:39.828Z","dependency_job_id":null,"html_url":"https://github.com/chuckh/polymer-quill","commit_stats":null,"previous_names":[],"tags_count":14,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/chuckh%2Fpolymer-quill","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/chuckh%2Fpolymer-quill/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/chuckh%2Fpolymer-quill/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/chuckh%2Fpolymer-quill/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/chuckh","download_url":"https://codeload.github.com/chuckh/polymer-quill/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":246743545,"owners_count":20826551,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["bubble-theme","delta","demo","medium","polymer-quill","snow-theme","webcomponents"],"created_at":"2024-08-01T09:00:19.975Z","updated_at":"2025-10-22T21:31:24.478Z","avatar_url":"https://github.com/chuckh.png","language":"HTML","funding_links":[],"categories":["Uncategorized"],"sub_categories":["Uncategorized"],"readme":"[![Published on webcomponents.org](https://img.shields.io/badge/webcomponents.org-published-blue.svg)](https://beta.webcomponents.org/element/PolymerElements/paper-button)\n[![Build Status](https://travis-ci.org/chuckh/polymer-quill.svg?branch=master)](https://travis-ci.org/chuckh/polymer-quill)\n\n# \\\u003cpolymer-quill\\\u003e \n\n## Polymer Quill Rich Text Editor\n\n- `\u003cpolymer-quill\u003e` element creates a Polymer Quill Rich Text Editor using the Snow Theme.\n- `\u003cpolymer-quill-bubble\u003e` element creates a Polymer Quill Rich Text Editor using the Bubble Theme (popup toolbar like Medium).\n- `\u003cpolymer-quill-html-render\u003e` element creates a Polymer Quill HTML Render\n\nQuill is a free, open source WYSIWYG editor built for the modern web.\nWith its modular architecture and expressive API, it is completely customizable to fit any need.\nLearn more at http://quilljs.com/\n\n### Screenshot Snow Theme\n![polymer-quill screenshot](polymer-quill-screenshot.png)\n\n\n```html\n\u003cpolymer-quill content=\"Hello World\"\u003e\u003c/polymer-quill\u003e\n\u003cpolymer-quill-bubble content=\"Hello World (click text to see toolbar)\" show-results\u003e\u003c/polymer-quill-bubble\u003e    \n\u003cpolymer-quill-html-render content='\u003ch2 class=\"ql-align-center\"\u003eHello World\u003c/h2\u003e'\u003e\u003c/polymer-quill-html-render\u003e\n```\n\n## Demo and API docs\nIf your are viewing this from webcomponents.org, use the below links for API and demos, not the links on right sidebar.\n\n- [API docs](https://chuckh.github.io/polymer-quill/#polymer-quill)\n- [Demo Snow Toolbar](https://chuckh.github.io/polymer-quill/components/polymer-quill/demo/)\n- [Demo Bubble Toolbar (Medium style)](https://chuckh.github.io/polymer-quill/components/polymer-quill/demo/bubble.html)\n- [Demo Quill HTML Render](https://chuckh.github.io/polymer-quill/components/polymer-quill/demo/html-render.html)\n\n### Examples\n\n#### Defaults (stores as Deltas every 2 seconds, does not show results, 50px height)\n\n    \u003cpolymer-quill content=\"Hello World\"\u003e\u003c/polymer-quill\u003e\n\n#### Defaults (stores as Deltas every 2 seconds, does not show results, 50px height)\n\n    \u003cpolymer-quill-bubble content=\"Hello World (click text to see toolbar)\"\u003e\u003c/polymer-quill-bubble\u003e    \n\n#### Custom (stores as HTML every 5 seconds, show results)\n\n    \u003cpolymer-quill content=\"Hello World\" store-as=\"html\" store-interval=\"5000\" show-results\u003e\u003c/polymer-quill\u003e\n\n#### Custom (stores as HTML every 5 seconds, show results)\n\n    \u003cpolymer-quill-html-render content=\"\u003ch2 class=\"ql-align-center\"\u003eHello World\u003c/h2\u003e\"\u003e\u003c/polymer-quill-html-render\u003e\n\n\n#### Demo example\n\n```html\n\u003cstyle is=\"custom-style\"\u003e\n  polymer-quill.full {\n    --polymer-quill-editor-max-height: 300px;\n    --polymer-quill-editor-min-height: 100px;\n  }\n\u003c/style\u003e\n\u003ch2\u003eFull Toolbar, Show Results, Max Height (300px), Min Height (100px), Save as Deltas, Save every 1 second\u003c/h2\u003e\n\u003cpolymer-quill content='{\"ops\":[{\"insert\":\"Hello World! - Store as Delta\"},{\"attributes\":{\"header\":2},\"insert\":\"\\n\"}]}'\n  class='full'\n  store-as=\"delta\"\n  save-interval=\"1000\"\n  toolbar-type=\"full\"\n  show-results\u003e\n\u003c/polymer-quill\u003e\n\u003ch2\u003eStandard Toolbar, Hide Results, Default height (100px), Save as HTML, Save every 2 seconds\u003c/h2\u003e\n\u003cpolymer-quill content=\"\u003ch2\u003eHello World! - Store as HTML\u003c/h2\u003e\" store-as=\"html\"\u003e\u003c/polymer-quill\u003e\n```\n\n## Styling\n\nThe following custom properties and mixins are available for styling. This allows the editor auto grow to the max-height.:\n\n### polymer-quill  (Snow theme)\nAlso had to make editor have `padding-bottom: 50px` to have link popup show.\n\nCustom property | Description | Default\n----------------|-------------|----------\n`--polymer-quill-editor-max-height` | Custom max-height for editor     | `400px`\n`--polymer-quill-editor-min-height` | Custom max-height for editor     | `50px`\n`--polymer-quill-editor-overflow`   | Custom overflow for editor       | `scroll`\n`--polymer-quill-editor-border`     | Custom min-height for editor     | `solid 1px #ccc`\n`--polymer-quill`                   | Mixin applied to the editor      | `{}`\n\nBelow 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.\n\n```\npolymer-quill {\n  --polymer-quill-editor-max-height: calc(100vh - 260px);\n  --polymer-quill-editor-min-height: 150px;\n  max-width: 870px;\n  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);\n  padding: 0;\n  margin-left: auto;\n  margin-bottom: 5px;\n  margin-right: auto;\n  border-radius: 5px;\n  background-color: #fff;\n  color: #212121;\n}\n```\n\n### polymer-quill-bubble  (Bubble theme)\n\nMax-height needs to be set for bubble popup toolbar to work with is default. \nAlso had to make editor have `padding-bottom: 50px` so toolbar displays for last line.\n\nCustom property | Description | Default\n----------------|-------------|----------\n`--polymer-quill-editor-max-height` | Custom max-height for editor     | `auto`\n`--polymer-quill-editor-min-height` | Custom min-height for editor     | `50px`\n`--polymer-quill-editor-overflow`   | Custom overflow for editor       | `scroll`\n`--polymer-quill-editor-border`     | Custom min-height for editor     | `solid 1px #ccc`\n`--polymer-quill`                   | Mixin applied to the editor      | `{}`\n\n## Install\n\n    bower install --save polymer-quill\n\n### Polymer Starter Kit 2\n\nIf 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.\n\n```javascript\n  // Setup Polymer options\n  window.Polymer = {\n    dom: 'shady',\n    lazyRegister: true\n  };\n```\n\n## License\n\n### The MIT License (MIT)\nCopyright (c) 2016 Chuck Horton\n\nPermission 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:\n\nThe above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.\n\nTHE 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.\n\n![open source initiative](https://github.com/chuckh/polymer-quill/raw/master/images/open-source-initiative.png)\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fchuckh%2Fpolymer-quill","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fchuckh%2Fpolymer-quill","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fchuckh%2Fpolymer-quill/lists"}