Video Tool for Editor.js, clone from editorjs-image
npm install @weekwood/editorjs-video
Video Block for the Editor.js. Clone from editor-js/image
- Uploading file from the device
- Pasting copied content from the web
- Pasting videos by drag-n-drop
- Pasting files and screenshots from Clipboard
- Allows adding a border, and a background
- Allows stretching an video to the container's full-width
Notes
This Tool requires server-side implementation for the file uploading. See backend response format for more details.
This Tool is also capable of uploading & displaying video files using the React-playerelement.
Get the package
``shell`
npm i --save-dev @weekwood/editorjs-video
Include module at your application
`javascript`
import VideoTool from '@editorjs/video';
#### Manual downloading and connecting
1. Upload folder dist from repositorydist/bundle.js
2. Add file to your page.
Add a new Tool to the tools property of the Editor.js initial config.
`javascript
import VideoTool from '@editorjs/video';
// or if you inject VideoTool via standalone script
const VideoTool = window.VideoTool;
var editor = EditorJS({
...
tools: {
...
video: {
class: VideoTool,
config: {
endpoints: {
byFile: 'http://localhost:8008/uploadFile', // Your backend file uploader endpoint
byUrl: 'http://localhost:8008/fetchUrl', // Your endpoint that provides uploading by Url
}
}
}
}
...
});
`
Video Tool supports these configuration parameters:
| Field | Type | Description |
| ----- | -------- | ------------------ |
| endpoints | {byFile: string, byUrl: string} | Endpoints for file uploading. string
Contains 2 fields:
__byFile__ - for file uploading
__byUrl__ - for uploading by URL |
| field | | (default: video) Name of uploaded video field in POST request |string
| types | | (default: video/*) 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 |{{uploadByFile: function, uploadByUrl: function}}
| uploader | | Optional custom uploading methods. See details below. |array
| actions | | Array with custom actions to show in the tool's settings menu. See details below. |
Note that if you don't implement your custom uploader methods, the endpoints param is required.
1. Add border
2. Stretch to full-width
3. Add background
Add extra setting-buttons by adding them to the actions-array in the configuration:`js${name} button clicked
actions: [
{
name: 'new_button',
icon: '',
title: 'New Button',
action: (name) => {
alert();`
return false;
}
}
]
By adding or return false at the end of your custom actions, you can determine wether the icon in the tool's settings is toggled or not. This is helpfull for actions that do not toggle between states, but execute a different action.video-tool--[button name]
If toggling is enabled, an class will be appended and removed from the container.
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 | | video's caption |boolean
| withBorder | | add border to video |boolean
| withBackground | | need to add background |boolean
| stretched | | stretch video to screen's width |
`json`
{
"type" : "video",
"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 video-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. Video tool shows saved video 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 to store, such as width, height, color, extension, etc
}
}
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 video.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 video file to the Editor
2. Editor pass pasted string to the Video 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. Video tool shows saved video 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, «video»).
You should save it and return the same response format as described above.
As mentioned at the Config Params section, you have an ability to provide own custom uploading methods.
It is a quite simple: implement uploadByFile and uploadByUrl methods and pass them via uploader config param.
Both methods must return a Promise that resolves with response in a format that described at the backend response format section.
| Method | Arguments | Return value | Description |
| -------------- | --------- | -------------| ------------|
| uploadByFile | File | {Promise.<{success, file: {url}}>} | Upload file to the server and return an uploaded video data |string
| uploadByUrl | | {Promise.<{success, file: {url}}>} | Send URL-string to the server, that should load video by this URL and return an uploaded video data |
Example:
`js
import VideoTool from '@editorjs/video';
var editor = EditorJS({
...
tools: {
...
video: {
class: VideoTool,
config: {
/**
* Custom uploader
*/
uploader: {
/**
* Upload file to the server and return an uploaded video data
* @param {File} file - file selected from the device or pasted by drag-n-drop
* @return {Promise.<{success, file: {url}}>}
*/
uploadByFile(file){
// your own uploading logic here
return MyAjax.upload(file).then(() => {
return {
success: 1,
file: {
url: 'https://codex.so/upload/redactor_videos/o_80beea670e49f04931ce9e3b2122ac70.jpg',
// any other video data you want to store, such as width, height, color, extension, etc
}
};
});
},
/**
* Send URL-string to the server. Backend should load video by this URL and return an uploaded video data
* @param {string} url - pasted video URL
* @return {Promise.<{success, file: {url}}>}
*/
uploadByUrl(url){
// your ajax request for uploading
return MyAjax.upload(file).then(() => {
return {
success: 1,
file: {
url: 'https://codex.so/upload/redactor_videos/o_e48549d1855c7fc1807308dd14990126.jpg',,
// any other video data you want to store, such as width, height, color, extension, etc
}
}
})
}
}
}
}
}
...
});
``