2.6.2 • Published 11 months ago

@editorjs/link v2.6.2

Weekly downloads
3,818
License
MIT
Repository
github
Last release
11 months ago

npm.io

Link Tool

Link Block for the Editor.js.

npm.io

Features

Allows adding link previews to your articles.

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

Installation

Get the package

yarn add @editorjs/link

Include module at your application

import LinkTool from '@editorjs/link';

Optionally, you can load this tool from CDN JsDelivr CDN

Usage

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

const 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:

FieldTypeDescription
endpointstringRequired: the endpoint for link data fetching.
headersobjectOptional: the headers used in the GET request.

Output data

This Tool returns data with following format

FieldTypeDescription
linkstringPasted link's url
metaobjectFetched link's data. Any data got from the backend. Currently, the plugin's design supports the 'title', 'image', and 'description' fields.
{
    "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 a 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,
    "link": "https://codex.so", // Optionally return a link to set the hyperlink URL
    "meta": {
        // ... any fields you want
    }
}

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

link - Optional response parameter to override the URL provided

meta — link fetched data.

Currently, the plugin's design supports the 'title', 'image', and 'description' fields. 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, it can contain any additional fields you want to store.

About CodeX

CodeX is a team of digital specialists around the world interested in building high-quality open source products on a global market. We are open for young people who want to constantly improve their skills and grow professionally with experiments in cutting-edge technologies.

🌐Join 👋TwitterInstagram
codex.socodex.so/join@codex_team@codex_team
byevolution@infinitebrahmanuniverse/nolb-_edi@everything-registry/sub-chunk-277editor-js-componentfibs-editoreditorjs-preconfigurededitorjs-reactgp-editorjsdraftsddoctors-editordoreactadotailahorul-editorhsl-strapi-plugin-react-editorjs@emilienkopp/ejs-factory@emilienkopp/html-factory@om-mediaworks/shacl-formreusecoresarman-vue-editor-jsstrapi-academy-plus-editorjsstrapi-editorjssmart-editorstd-pagestrapi-plugin-editorstrapi-plugin-editorjsstrapi-plugin-editorjs-fieldstrapi-plugin-react-editorjs-extended-embedstrapi-plugin-react-editorjsmurph-projectmtxtrpcv2nuxt3-editorjsreact-editor-simple-imagereact-editor-simple-image.jsquickvue-editorjsui-duck@rainyland-dev/strapi-plugin-editorjs@smileeye.edu.vn/editor@softkit/strapi-plugin-react-editorjs@questflow/canvas@todokek/react-editor.js@tienlucky/storage@vt7/vue-editor@virtual-spirit/vspace-labs@dicarbene/nuxt3-editorjs@ddoctors.ru/editorjs@kaniyarasu/react-editor.js@keystonejs-contrib/fields-editorjs@datahu/client@datahu/component@datahu/designer@fakel/rest-admin@canburaks/fibs-editor@cromwell/admin-panel@itfin/components@itandu/admin-panel@highoutput/neyar@lotsof/carpenter@lotsof/json-schema-formblock-article-js@swiftease/atali-form@4kda/vuetify-cifrum-demo-app@zdzcode/zc-web-vuejs-core@appconda/console-sdk@appconda/react-sdk@appconda/sdk@brandontle/react-editor.js@zalastax/nolb-_edi@bsol-oss/form-studio-answer-component@rjgf/rj-components@rypock/react-frontend@hyype-inc/widget@ten24group/ui24@celmino/sdk@celmino/sdk-console@casimir.one/vue-editorjs@carabi/ui@realmocean/editor@realmocean/sdk@acf-int/strapi-plugin-editorjs@acf-int/strapi-plugin-react-editorjs@bigbossstudio/strapi-plugin-editorjsall-in-one-editorjsbyevolution-components@nwire/amit-design-systemchatnext-assistantchatnext-uichatnext-ui-assistant-app-teset@oak-digital/strapi-plugin-react-editorjs
2.6.1

11 months ago

2.6.0

11 months ago

2.6.2

11 months ago

2.5.0

2 years ago

2.4.2

2 years ago

2.4.1

2 years ago

2.4.0

3 years ago

2.3.1

4 years ago

2.3.0

4 years ago

2.2.1

4 years ago

2.2.0

4 years ago

2.1.3

5 years ago

2.1.2

6 years ago

2.1.1

6 years ago

2.1.0

6 years ago