1.0.2 • Published 1 year ago
@davidyappeter/editorjs-simple-image v1.0.2
Simple Image Tool
Provides Image Blocks for the Editor.js.
Works only with pasted image URLs and requires no server-side uploader.
Installation
Get the package
yarn add @davidyappeter/editorjs-simple-imageInclude module at your application
import SimpleImage from "@davidyappeter/editorjs-simple-image";Usage
Add a new Tool to the tools property of the Editor.js initial config.
var editor = EditorJS({
...
tools: {
...
image: SimpleImage,
}
...
});Config Params
| Config Param | Type | Description |
|---|---|---|
| loader | function(string): string | Image Loader for multiline copy type 'tag' |
| uploader | function(string): Promise.<UploadResponseFormat> | File uploader that required the file url (use proxy server) |
Tool's settings
Add border
Stretch to full-width
Add background
Output data
| Field | Type | Description |
|---|---|---|
| file_id | string | File Id |
| url | string | image's url |
| caption | string | image's caption |
| withBorder | boolean | add border to image |
| withBackground | boolean | need to add background |
| stretched | boolean | stretch image to screen's width |
{
"file_id": "file_unique_id",
"type": "image",
"data": {
"url": "https://www.tesla.com/tesla_theme/assets/img/_vehicle_redesign/roadster_and_semi/roadster/hero.jpg",
"caption": "Roadster // tesla.com",
"withBorder": false,
"withBackground": false,
"stretched": true
}
}