editor-js / warning

Warning Tool for CodeX Editor 2.0

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

Get the package

yarn add @editorjs/warning

Include module at your application

import Warning from '@editorjs/warning';

Optionally, you can load this tool from CDN JsDelivr CDN

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."
    }
}

warning's Issues

Implement Warning tool redesign

Update warning tool appearance according to the mockups.
For precise figma mockups contact @TatianaFomina or @neSpecc

New design examples:

Empty

Filled

Output format: Which properties (if any) can be null omitted?

For a valid warning block, can any of the title or message properties under any circumstances (now or in the future) be null or omitted? Or are any of the aforementioned properties guaranteed to always be present and non-null for this block to be valid?

Context: I'm a back-end .NET developer needing to parse Editor.js documents. The readme lists the aforementioned properties but does not explicitly guarantee that they will always be present and non-null. Back-end deserialization/parsing in strongly typed languages would be easier with some guarantees about which properties can and can not be null/omitted. (Ideally, any such guarantees should be added to the readme to ensure they are formalized and kept in the future.)

Add i18n support

When we go to the documentation we see this plugin can be localizable, but in real, this has no the API support.

Could you implement it?

Thank you

How to transfor warning block from "edit mode" to "preview mode"?

Hello,
I used the warning plugin just like document, and I want to display a warning like demo preview, but I can't find any API. Can it be transfored like this? how?
Thanks!