Image Tool for CodeX.Editor
npm install codex.editor.image
Image Block for the CodeX Editor.
- Uploading file from the device
- Pasting copied content from the web
- Pasting images by drag-n-drop
- Pasting files and screenshots from Clipboard
- Allows to add border, background
- Allows to stretch image to the container's full-width
Note This Tool requires server-side implementation for file uploading. See backend response format for more details.
Get the package
``shell`
npm i --save-dev codex.editor.image
Include module at your application
`javascript`
const ImageTool = require('codex.editor.image');
1. Upload folder dist from repositorydist/bundle.js
2. Add file to your page.
You can load specific version of package from jsDelivr CDN.
https://cdn.jsdelivr.net/npm/codex.editor.image@1.0.0
Then require this script on page with CodeX Editor through the tag.
Add a new Tool to the tools property of the CodeX Editor initial config.
`javascript
var editor = CodexEditor({
...
tools: {
...
image: {
class: ImageTool,
config: {
endpoints: {
byFile: 'http://localhost:8008/uploadFile', // Your backend file uploader endpoint
byUrl: 'http://localhost:8008/fetchUrl', // Your endpoint that provides uploading by Url
}
}
}
}
...
});
`
Image Tool supports these configuration parameters:
| Field | Type | Description |
| ----- | -------- | ------------------ |
| endpoints | {byFile: string, byUrl: string} | Required Endpoints for file uploading. string
Contains 2 fields:
__byFile__ - for file uploading
__byUrl__ - for uploading by URL |
| field | | (default: image) Name of uploaded image field in POST request |string
| types | | (default: image/*) Mime-types of files that can be accepted with file selection.|object
| additionalRequestData | | Object with any data you want to send with uploading requests |object
| additionalRequestHeaders | | Object with any custom headers which will be added to request. See example |string
| captionPlaceholder | | (default: Caption) Placeholder for Caption input |string
| buttonContent | | Allows to override HTML content of «Select file» button |
1. Add border
2. Stretch to full-width
3. Add background
This Tool returns data with following format
| Field | Type | Description |
| -------------- | --------- | ------------------------------- |
| file | object | Uploaded file data. Any data got from backend uploader. Always contain the url property |string
| caption | | image's caption |boolean
| withBorder | | add border to image |boolean
| withBackground | | need to add background |boolean
| stretched | | stretch image to screen's width |
`json`
{
"type" : "image",
"data" : {
"file": {
"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
}
}
This Tool works by one of the following schemes:
1. Uploading files from the device
2. Uploading by URL (handle image-like URL's pasting)
3. Uploading by drag-n-drop file
4. Uploading by pasting from Clipboard
Scenario:
1. User select file from the device
2. Tool sends it to your backend (on config.endpoint.byFile route)
3. Your backend should save file and return file data with JSON at specified format.
4. Image tool shows saved image and stores server answer
So, you can implement backend for file saving by your own way. It is a specific and trivial task depending on your
environment and stack.
Response of your uploader should cover following format:
`json5`
{
"success" : 1,
"file": {
"url" : "https://www.tesla.com/tesla_theme/assets/img/_vehicle_redesign/roadster_and_semi/roadster/hero.jpg",
// ... and any additional fields you want
}
}
success - uploading status. 1 for successful, 0 for failed
file - uploaded file data. Must contain an url field with full public path to the uploaded image.file
Also, can contain any additional fields you want to store. For example, width, height, id etc.
All additional fields will be saved at the object of output data.
Scenario:
1. User pastes an URL of the image file to the Editor
2. Editor pass pasted string to the Image Tool
3. Tool sends it to your backend (on config.endpoint.byUrl route) via 'url' POST-parameter
3. Your backend should accept URL, download and save the original file by passed URL and return file data with JSON at specified format.
4. Image tool shows saved image and stores server answer
Response of your uploader should be at the same format as described at «Uploading files from device» section
Your backend will accept file as FormData object in field name, specified by config.field (by default, «image`»).
You should save it and return the same response format as described above.