Giter VIP home page Giter VIP logo

editorjs-quote's Introduction

Quote Tool

Provides Quote Blocks for the Editor.js.

Warning:
This is a fork of the upstream repository, that removes the alignment options, because I already handle alignment using https://github.com/kaaaaaaaaaaai/editorjs-alignment-blocktune, and the two options conflicted. If you want the most up-to-date version of the plugin, or you do need the alignment options, please use the upstream repo instead.

Installation

Download to your project's source dir

Download the repo and build using Node:

git clone https://github.com/RobinBoers/editorjs-quote
npm i
npm run build
  1. Move dist folder to your project
  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/@editorjs/quote@latest

Then require this script on page with Editor.js.

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

Usage

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

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

Or init Quote Tool with additional settings

var editor = EditorJS({
  ...
  
  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

Output data

Field Type Description
text string quote's text
caption string caption or an author
{
    "type" : "quote",
    "data" : {
        "text" : "The unexamined life is not worth living.",
        "caption" : "Socrates"
    }
}

editorjs-quote's People

Contributors

talyguryn avatar dependabot[bot] avatar tatianafomina avatar nespecc avatar gohabereg avatar polinashneider avatar khaydarov avatar robinboers avatar ivansieder avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.