Skip to content
Link Tool for Editor.js 2.0
Branch: master
Clone or download
PolinaShneider Merge pull request #9 from editor-js/improve-errors-handling
Improve response format errors handling
Latest commit 470a64c Mar 7, 2019
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
assets/gif move gif to assets directory Mar 7, 2019
dev Fix comment also Jan 25, 2019
dist Update styles Mar 7, 2019
src Update styles Mar 7, 2019
.babelrc Get rid of polyfill Jan 27, 2019
.eslintrc Improve behaviour in error Feb 9, 2019
.gitignore Link 2.0 initial Jan 23, 2019
.npmignore move gif to assets directory Mar 7, 2019
README.md
package.json
webpack.config.js update styles Feb 15, 2019
yarn.lock Feature/renaming (#5) Mar 2, 2019

README.md

Link Tool

Link Block for the Editor.js.

Features

Allows to add link previews to your articles.

Note: this Tool requires server-side implementation for link data fetching. See backend response format for more details.

Installation

Install via NPM

Get the package

npm i --save-dev @editorjs/link

Include module at your application

const LinkTool = require('@editorjs/link');

Download to your project's source dir

  1. Download 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/@editorjs/link@2.0.0

Then require this script on page with Editor.js through the <script src=""></script> tag.

Usage

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

var editor = EditorJS({
  ...

  tools: {
    ...
    linkTool: {
      class: LinkTool,
      config: {
        endpoint: 'http://localhost:8008/fetchUrl', // Your backend endpoint for url data fetching
      }
    }
  }

  ...
});

Config Params

Link Tool supports these configuration parameters:

Field Type Description
endpoint string Required: endpoint for link data fetching.

Output data

This Tool returns data with following format

Field Type Description
link string Pasted link url
meta object Fetched link data. Any data got from backend. Currently title, image and description are supported by plugin's design.
{
    "type" : "linkTool",
    "data" : {
        "link" : "https://codex.so",
        "meta" : {
            "title" : "CodeX Team",
            "site_name" : "CodeX",
            "description" : "Club of web-development, design and marketing. We build team learning how to build full-valued projects on the world market.",
            "image" : {
                "url" : "https://codex.so/public/app/img/meta_img.png"
            }
        }
    }
}

Backend response format

You can implement backend for link data fetching your own way. It is a specific and trivial task depending on your environment and stack.

Backend response should cover following format:

{
    "success" : 1,
    "meta": {
        // ... any fields you want
    }
}

success — uploading status. 1 for successful, 0 for failed

meta — link fetched data.

Currently title, image and description fields are supported by plugin's design . They should have the following format in the response:

{
    "success" : 1,
    "meta": {
        "title" : "CodeX Team",
        "description" : "Club of web-development, design and marketing. We build team learning how to build full-valued projects on the world market.",
        "image" : {
            "url" : "https://codex.so/public/app/img/meta_img.png"
        }
    }
}

Also, can contain any additional fields you want to store.

You can’t perform that action at this time.