Skip to content

Commit 53db633

Browse files
committed
docs: 📝 add modules docs
1 parent 34b7550 commit 53db633

File tree

3 files changed

+74
-2
lines changed

3 files changed

+74
-2
lines changed

docs/content/.vitepress/config.js

Lines changed: 10 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,12 @@ module.exports = {
88
lang: 'en-US',
99
title: 'VueQuill',
1010
description: 'Rich Text Editor Component for Vue 3.',
11-
head: [['link', { rel: 'icon', type: 'image/svg+xml', href: '/vue-quill/logo.svg' }]],
11+
head: [
12+
[
13+
'link',
14+
{ rel: 'icon', type: 'image/svg+xml', href: '/vue-quill/logo.svg' },
15+
],
16+
],
1217
themeConfig: {
1318
repo: 'vueup/vue-quill',
1419
logo: '/logo.svg',
@@ -92,6 +97,10 @@ module.exports = {
9297
text: 'Toolbar',
9398
link: '/guide/toolbar',
9499
},
100+
{
101+
text: 'Modules',
102+
link: '/guide/modules',
103+
},
95104
{
96105
text: 'Options',
97106
link: '/guide/options',

docs/content/api/index.md

Lines changed: 7 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -49,7 +49,13 @@
4949
## toolbar
5050
- **Type:** `String | Array | Object`
5151

52-
Toolbar options to configure the default toolbar icons using an array of format names, see [Toolbar](../guide/toolbar.md) seection for more details.
52+
Toolbar options to configure the default toolbar icons using an array of format names, see [Toolbar](../guide/toolbar.md) section for more details.
53+
54+
## modules
55+
- **Type:** `[string, any, object] | [string, any, object][]`
56+
- **Type Description:** `[name, module, options]`
57+
58+
Options to register modules, see [Modules](../guide/modules.md) section for more details.
5359

5460
## options
5561
- **Type:** `Object`

docs/content/guide/modules.md

Lines changed: 57 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,57 @@
1+
# Modules
2+
Modules allow Quill’s behavior and functionality to be customized. To enable a module, simply include it in a [`modules` prop](../api/index.md#modules).
3+
4+
## Example
5+
6+
In this example I am gonna use [quill-blot-formatter](https://github.com/Fandom-OSS/quill-blot-formatter), a module for resizing and realigning images and iframe video.
7+
8+
~~~ vue
9+
<template>
10+
<QuillEditor :modules="modules" toolbar="full" />
11+
</template>
12+
13+
<script lang="ts">
14+
import { ref, defineComponent } from 'vue'
15+
import { QuillEditor } from '@vueup/vue-quill'
16+
import BlotFormatter from 'quill-blot-formatter'
17+
import '@vueup/vue-quill/../dist/vue-quill.snow.css'
18+
19+
export default defineComponent({
20+
components: {
21+
QuillEditor,
22+
},
23+
setup: () => {
24+
const modules = ['blotFormatter', BlotFormatter, {/* options */},]
25+
return { modules }
26+
},
27+
})
28+
</script>
29+
~~~
30+
31+
See [Quill modules docs](https://quilljs.com/docs/modules/) for more details.
32+
33+
## Quill Modules
34+
35+
- [quill-autoformat](https://github.com/weavy/quill-autoformat) - Module for transforming text including mentions, links and hashtags
36+
- [quill-better-table](https://github.com/soccerloway/quill-better-table) - A module for table editting, support resizing column, multiline cell, merging/unmerging cells
37+
- [quill-blot-formatter](https://github.com/Fandom-OSS/quill-blot-formatter) - A module for resizing and realigning images and iframe videos
38+
- [quill-cursors](https://github.com/reedsy/quill-cursors) - A multi cursor module for Quill text editor
39+
- [quill-emoji](https://github.com/contentco/quill-emoji) - Quill module toolbar extension for emoji
40+
- [quill-focus](https://amka.github.io/quill-focus/) - A Quill.js module that adds "focus mode"
41+
- [quill-form](https://github.com/weavy/quill-form) - Module for automatic form input and submit binding
42+
- [quill-find-replace-module](https://github.com/MuhammedAlkhudiry/quill-find-replace-module) - A module for Quill.js for finding words and replacing them
43+
- [quill-html-edit-button](https://github.com/benwinding/quill-html-edit-button) - A module to add a button which allows you to view/edit the raw HTML in the quill editor.
44+
- [quill-image-compress](https://github.com/benwinding/quill-image-compress) - A module to compress images before adding them to the editor.
45+
- [quill-image-drop-module](https://github.com/kensnyder/quill-image-drop-module) - A module to allow images to be pasted and drag/dropped into the editor
46+
- [quill-image-resize-module](https://github.com/kensnyder/quill-image-resize-module) - A module to allow images to be resized (not maintained: use quill-blot-formatter instead)
47+
- [quill-image-uploader](https://github.com/NoelOConnell/quill-image-uploader) - Upload image to server, adds toolbar button and handles dropped/pastes images
48+
- [quill-image-url-drop-module](https://github.com/riencroonenborghs/quill-image-url-drop-module) - A module to allow images' URLs to be drag/dropped into the editor
49+
- [quill-magic-url](https://github.com/visualjerk/quill-magic-url) - Checks for URLs during typing / pasting and automatically converts them to links
50+
- [quill-markdown-shortcuts](https://github.com/patleeman/quill-markdown-shortcuts) - Quill.js module that converts markdown to rich text formatting while typing
51+
- [quill-markdown-toolbar](https://github.com/park53kr/quill-markdown-toolbar) - A Quill.js module for converting markdown text to rich text format
52+
- [quill-mention](https://github.com/afconsult/quill-mention) - @mentions for the Quill rich text editor
53+
- [quill-paste-smart](https://github.com/Artem-Schander/quill-paste-smart) - Paste only supported HTML
54+
- [quill-placeholder-module](https://github.com/jspaine/quill-placeholder-module) - A quill module for adding placeholders
55+
- [quill-placeholder-autocomplete-module](https://github.com/Datananas/quill-placeholder-autocomplete) - brings autocomplete to "quill-placeholder-module"
56+
- [quill-rich-voice-editor](https://github.com/fabiancelik/rich-voice-editor) - A Quill.js module for SSML tags and functions to build better voice applications
57+
- [quill-table-ui](https://github.com/volser/quill-table-ui) - A module for table UI

0 commit comments

Comments
 (0)