1.4.1 • Published 3 years ago

file-manager-editor-js v1.4.1

Weekly downloads
-
License
ISC
Repository
github
Last release
3 years ago

npm.io npm.io npm.io npm.io npm.io

File Manager To EditorJs

This file manager works with files and photos and audio.

Installation

Install via NPM

Get the package

npm i file-manager-editor-js --save

Include module at your application

import EditorJsFm from "file-manager-editor-js/src/lib/editor-js-connect";
import "file-manager-editor-js/src/style/main.scss";

Usage

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

var editor = EditorJS({
  ...
  
  tools: {
    ...
    fileManager: {
      class: EditorJsFm,
      config: {
        lang:"ru" || "en",
        token: "token",
        apiUrl: "https://example/api/v1",
        uploadUrl: "https://example",
        routes: {
            allFoldersOrCurentFolder: 'filemanager/folders/2' or 'filemanager/folders',
            subFoldersAndFiles: 'filemanager/folders/${_id}',
            updateFolder: 'filemanager/folder/${_id}',
            deleteFolder: 'filemanager/folder/${_id}',
            createFolder: 'filemanager/folders',
            updateFile: 'filemanager/file/${_id}',
            deleteFile: 'filemanager/file/${_id}',
            uploadFile: 'filemanager/folders/${_id}/file'
        }
      }
    }
  }
  
  ...
});

${_id} - this means that route will contain an id (that is, action on the specific folder or file or image)

Config Params

FieldTypeDescription
tokenstringauthorization token
apiUrlstringroute to the API
uploadUrlstringdomain where is image/file/audio
routesobjectroutes for work with api

Routes

RouteDescription
allFoldersOrCurentFolderOn this route we receive all folders from the server, or a specific folder to id
subFoldersAndFilesOn this route we receive all folders and files/images to a specific folder
updateFolderOn this route we edit a folder, request params {title: 'new title', id: folder id}
deleteFolderOn this route we deleted a folder
createFolderOn this route we create subFolder, request params {title: 'folder name (default: new folder)', folderId: parent folder id or ''}
updateFileOn this route we edit a file/image, request params {title: 'new title', alt: 'new alt'}
deleteFileOn this route we deleted a file/image
uploadFileOn this route we upload file/image to folder, request params {folderId: folder id where upload file, file: upload file}

If route allFoldersOrCurentFolder includes id to folder 'filemanager/folders/ID', server response must be an object.

If route allFoldersOrCurentFolder does not include id to folder 'filemanager/folders', server response must be an array of objects.

Route allFoldersOrCurentFolder have required fields:

FieldTypeDescription
titlestringfolder name
idstringfolder id

Route subFoldersAndFiles have required fields:

FieldTypeDescription
titlestringfolder name
idstringfolder id
Filearrayfile to main folder
FolderarraysubFolder to main folder

Field File have required fields:

FieldTypeDescription
altstringalt
idstringid
mimestringmime type ('application/msword','image/png', ...)
pathstringpath to file or image without domain ('/uploads/2021-04-08/1617882721-1614172940-ExamTests_V1-(1).doc')
titlestringfile name

Field Folder have required fields:

FieldTypeDescription
idstringid
titlestringfile name

Output data

FieldTypeDescription
urlstringimage's/files/audio url
namestringimage's/files/audio name
typestringtype ('image' or 'audio' or 'file')
{
    "type" : "FileManager",
    "data" : {
        "url" : "https://example/hero.jpg",
        "name" : "Name",
        "type" : "image or file or audio"
    }
}
1.4.1

3 years ago

1.4.0

3 years ago

1.3.0

3 years ago

1.1.1

3 years ago

1.1.0

3 years ago

1.2.5

3 years ago

1.2.4

3 years ago

1.2.3

3 years ago

1.1.3

3 years ago

1.1.2

3 years ago

1.0.5

3 years ago

1.0.4

3 years ago

1.0.3

3 years ago

1.0.2

3 years ago

1.0.1

3 years ago

1.0.0

3 years ago