Warning Tool

Provides Warning Block for the CodeX Editor. Block has title and message. It can be used, for example, for editorials notifications or appeals.

Installation

Install via NPM

Get the package

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

Include module at your application

const Warning = require('codex.editor.warning');

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/[email protected]

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: {
    ...
    warning: Warning,
  },
  
  ...
});

Or init Warning Tool with additional settings

var editor = CodexEditor({
  ...
  
  tools: {
    ...
    warning: {
      class: Warning,
      inlineToolbar: true,
      shortcut: 'CMD+SHIFT+W',
      config: {
        titlePlaceholder: 'Title',
        messagePlaceholder: 'Message',
      },
    },
  },
  
  ...
});

Config Params

| Field | Type | Description | | ------------------ | -------- | ----------------------------------| | titlePlaceholder | string | Warning Tool's title placeholder | | messagePlaceholder | string | Warning Tool's message placeholder|

Output data

| Field | Type | Description | | --------- | -------- | -----------------| | title | string | warning's title | | message | string | warning's message|

{
    "type" : "warning",
    "data" : {
        "title" : "Note:",
        "message" : "Avoid using this method just for lulz. It can be very dangerous opposite your daily fun stuff."
    }
}