Quote Tool

Provides Quote Blocks for the CodeX Editor.


Installation

$3

Get the package

``shell
npm i --save-dev codex.editor.quote
`

Include module at your application

`javascript
const Quote = require('codex.editor.quote');
`

$3

1. Upload folder dist from repository
2. Add dist/bundle.js file to your page.

$3

You can load specific version of package from jsDelivr CDN.

https://cdn.jsdelivr.net/npm/codex.editor.quote@2.0.0

Then require this script on page with CodeX Editor.

`html

`

Usage

Add a new Tool to the tools property of the CodeX Editor initial config.

`javascript
var editor = CodexEditor({
...

tools: {
...
quote: Quote,
},

...
});
`

Or init Quote Tool with additional settings

`javascript
var editor = CodexEditor({
...

tools: {
...
quote: {
class: Quote,
inlineToolbar: true,
shortcut: 'CMD+SHIFT+O',
config: {
quotePlaceholder: 'Enter a quote',
captionPlaceholder: 'Quote\'s author',
},
},
},

...
});
`

Config Params

| Field | Type | Description |
| ------------------ | -------- | ----------------------------|
| quotePlaceholder | string | quote's placeholder string |
| captionPlaceholder | string | caption's placeholder string|

Tool's settings

![](https://capella.pics/0db5d4de-c431-4cc2-90bf-bb1f4feec5df.jpg)

You can choose alignment for the quote. It takes no effect while editing, but saved the «alignment» param.

Output data

| Field | Type | Description |
| --------- | -------- | -------------------- |
| text | string | quote's text |
| caption | string | caption or an author |
| alignment | string | left or center |


`json
{
"type" : "quote",
"data" : {
"text" : "The unexamined life is not worth living.",
"caption" : "Socrates",
"alignment" : "left"
}
}
``