npm

Need private packages and team management tools?Check out npm Orgs. »

codex.editor.quote

2.1.5 • Public • Published

Quote Tool

Provides Quote Blocks for the CodeX Editor.

Installation

Install via NPM

Get the package

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

Include module at your application

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

Download to your project's source dir

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

Load from CDN

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.

<script src="..."></script>

Usage

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

var editor = CodexEditor({
  ...
  
  tools: {
    ...
    quote: Quote,
  },
  
  ...
});

Or init Quote Tool with additional settings

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

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
{
    "type" : "quote",
    "data" : {
        "text" : "The unexamined life is not worth living.",
        "caption" : "Socrates",
        "alignment" : "left"
    }
}

install

npm i codex.editor.quote

Downloadsweekly downloads

20

version

2.1.5

license

MIT

homepage

github.com

repository

Gitgithub

last publish

collaborators

  • avatar
Report a vulnerability