Hyperlink Tool

A tool link with target & rel attribute for Editor.js.

Installation

Get the package via NPM

npm i editorjs-hyperlink -D

or via Yarn

yarn add editorjs-hyperlink -D

Include module at your application

const Hyperlink = require('editorjs-hyperlink');

Usage

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

var editor = EditorJS({
  ...
  
  tools: {
    ...

    hyperlink: {
      class: Hyperlink,
      config: {
        shortcut: 'CMD+L',
        target: '_blank',
        rel: 'nofollow',
        availableTargets: ['_blank', '_self'],
        availableRels: ['author', 'noreferrer'],
        validate: false,
      }
    },

    ...
  },

  ...

  i18n: {
    toolNames: {
      Hyperlink: 'Link'
    },
    tools: {
      hyperlink: {
        Save: 'Salvar',
        'Select target': 'Seleziona destinazione',
        'Select rel': 'Wählen rel'
      }
    }
  }
  
  ...
});

Config Params (optional)

| Field | Type | Description | | ------ | -------- | ---------------- | | shortcut | string | Shortcut, defaults to 'CMD+L' | | target | string | Defines a default target, defaults to null | | rel | string | Defines a default rel, defaults to null | | availableTargets | string[] | Available link targets, defaults to all targets.If empty array is provided, the control will be hidden and the default value applied. | | availableRels | string[] | Available link rels, defaults to all rels.If empty array is provided, the control will be hidden and the default value applied. | | validate | boolean | Defines if an URL should be validated on saving |

License

MIT