Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/KillerCodeMonkey/stencil-quill
Native web components for the Quill Rich Text Editor built with stencil
https://github.com/KillerCodeMonkey/stencil-quill
component editor quill quill-editor quilljs renderer rendering rich-text-editor stencil stencil-quill viewer webcomponent webcomponents wysiwyg
Last synced: 7 days ago
JSON representation
Native web components for the Quill Rich Text Editor built with stencil
- Host: GitHub
- URL: https://github.com/KillerCodeMonkey/stencil-quill
- Owner: KillerCodeMonkey
- License: mit
- Created: 2018-09-21T10:38:03.000Z (about 6 years ago)
- Default Branch: master
- Last Pushed: 2024-10-29T05:03:27.000Z (12 days ago)
- Last Synced: 2024-10-30T20:07:09.746Z (10 days ago)
- Topics: component, editor, quill, quill-editor, quilljs, renderer, rendering, rich-text-editor, stencil, stencil-quill, viewer, webcomponent, webcomponents, wysiwyg
- Language: TypeScript
- Homepage:
- Size: 2.59 MB
- Stars: 38
- Watchers: 3
- Forks: 7
- Open Issues: 6
-
Metadata Files:
- Readme: readme.md
- Contributing: .github/CONTRIBUTING.md
- Funding: .github/FUNDING.yml
- License: LICENSE
Awesome Lists containing this project
- awesome-quill - stencil-quill - Native web component for the Quill Rich Text Editor built with stencil (Uncategorized / Uncategorized)
README
# stencil-quill [](https://github.com/KillerCodeMonkey/stencil-quill/actions/)
Native web components for the [Quill Rich Text Editor](https://quilljs.com/)
## Donate/Support
If you like my work, feel free to support it. Donations to the project are always welcomed :)
PayPal: [PayPal.Me/bengtler](https://paypal.me/bengtler)
## Examples
- [Live Demo](https://killercodemonkey.github.io/stencil-quill)
## Installation
- `npm install stencil-quill`
- load `node_modules/stencil-quill/dist/quill-components.js` in your index.html or add it to your build process or project
- do not forget to install `quill` **v2!** and include it + theme css in your buildprocess, module or `index.html`! (the component is using the global Quill object)
## QuillEditor component
### HTML-Tag
```HTML
```
### Config
- [Check the component readme](https://github.com/KillerCodeMonkey/stencil-quill/tree/master/src/components/quill-editor)
- content - the base content of the editor passed as string or JSON string
- readOnly (true | false) if user can edit content
- formats - array of allowed formats/groupings
- format - model format - default: `html`, values: `html | text | json`, sets the model value type - html = html string, json = quill operations as json string, text = plain text
- modules - configure/disable quill modules, passed as JSON-string!, e.g toolbar or add custom toolbar via html element default is
```
{
toolbar: [
['bold', 'italic', 'underline', 'strike'], // toggled buttons
['blockquote', 'code-block'],
[{ 'header': 1 }, { 'header': 2 }], // custom button values
[{ 'list': 'ordered'}, { 'list': 'bullet' }],
[{ 'script': 'sub'}, { 'script': 'super' }], // superscript/subscript
[{ 'indent': '-1'}, { 'indent': '+1' }], // outdent/indent
[{ 'direction': 'rtl' }], // text direction
[{ 'size': ['small', false, 'large', 'huge'] }], // custom dropdown
[{ 'header': [1, 2, 3, 4, 5, 6, false] }],
[{ 'color': [] }, { 'background': [] }], // dropdown with defaults from theme
[{ 'font': [] }],
[{ 'align': [] }],
['clean'], // remove formatting button
['link', 'image', 'video'] // link and image, video
]
};
```
- theme - bubble/snow, default is `snow`
- styles - set a styles object, e.g. `styles="{height: '250px'}"`
- placeholder - placeholder text, default is `Insert text here ...`
- bounds - boundary of the editor, default `document.body`, pass 'self' to attach the editor element
- possbility to create a custom toolbar via a custom slot `quill-toolbar`:
```
Aref Ruqaa
Mirza
Roboto
```
- customToolbarPosition - if you are working with a custom toolbar you can switch the position :). - default: `top`, possible values `top`, `bottom`
- debug - set log level `warn`, `error`, `log` or `false` to deactivate logging, default: `warn`
- defaultEmptValue - set the default empty value, e.g. empty string, default `null`
[Full Quill Toolbar HTML](https://github.com/quilljs/quill/blob/f75ff2973f068c3db44f949915eb8a74faf162a8/docs/_includes/full-toolbar.html)
### Events
- editorInit - editor instance
```
editor
```
- editorContentChange - text is updated by 'user'
```
{
editor: editorInstance,
html: html,
text: text,
content: content,
delta: delta,
oldDelta: oldDelta,
source: source
}
```
- editorSelectionChange - selection is updated, also triggered for onBlur and onFocus, because the selection changed
```
{
editor: editorInstance,
range: range,
oldRange: oldRange,
source: source
}
```
- editorChange - text or selection is updated - independent of the source
```
{
editor: editorInstance, // Quill
event: 'text-change' // event type
html: html, // html string
text: text, // plain text string
content: content, // Content - operatins representation
delta: delta, // Delta
oldDelta: oldDelta, // Delta
source: source // ('user', 'api', 'silent' , undefined)
}
```
or
```
{
editor: editorInstance, // Quill
event: 'selection-change' // event type
range: range, // Range
oldRange: oldRange, // Range
source: source // ('user', 'api', 'silent' , undefined)
}
```
- editorFocus - editor is focused
```
{
editor: editorInstance, // Quill
source: source // ('user', 'api', 'silent' , undefined)
}
```
- editorBlur - editor is blured
```
{
editor: editorInstance, // Quill
source: source // ('user', 'api', 'silent' , undefined)
}
```
## QuillView component
It renders a readOnly quilljs editor without a border and toolbar. Does not provide any Events, but has similar properties.
### HTML-Tag
```HTML
```
### Config
- [Check the component readme](https://github.com/KillerCodeMonkey/stencil-quill/tree/master/src/components/quill-view)
- content - the base content of the editor passed as string or JSON string
- formats - array of allowed formats/groupings
- format - model format - default: `html`, values: `html | text | json`, sets the model value type - html = html string, json = quill operations as json string, text = plain text
- modules - configure/disable quill modules, passed as JSON-string! - keep in mind toolbar will be set to false anyways
- theme - bubble/snow, default is `snow`
- styles - set a styles object, e.g. `styles="{height: '250px'}"`
- debug - set log level `warn`, `error`, `log` or `false` to deactivate logging, default: `warn`
- defaultEmptValue - set the default empty value, e.g. empty string, default `null`
## QuillViewHTML component
It renders an quilljs html string as you would expect it without createing a quilljs instance.
### HTML-Tag
```HTML
```
### Config
- [Check the component readme](https://github.com/KillerCodeMonkey/stencil-quill/tree/master/src/components/quill-view-html)
- content - the base content of the editor passed as string or JSON string
- theme - bubble/snow, default is `snow`
## Using the components
### Script tag
- [Publish to NPM](https://docs.npmjs.com/getting-started/publishing-npm-packages)
- Put a script tag similar to this `` in the head of your index.html
- Then you can use the element anywhere in your template, JSX, html etc
### Node Modules
- Run `npm install stencil-quill --save`
- Put a script tag similar to this `` in the head of your index.html
- Then you can use the element anywhere in your template, JSX, html etc
### In a stencil-starter app
- Run `npm install stencil-quill --save`
- Add an import to the npm packages `import quill-components;`
- Then you can use the element anywhere in your template, JSX, html etc