1.0.1 • Published 2 years ago

editorjs-audio-tool v1.0.1

Weekly downloads
-
License
MIT
Repository
github
Last release
2 years ago

editorjs-audio-tool

Audio Tool for Editor.js

Install

For React

npm i  editorjs-audio-tool

example

import { useEffect } from 'react'
import AudioTool from 'editorjs-audio-tool'
import EditorJS from '@editorjs/editorjs'
import 'editorjs-audio-tool/dist/style.css'
function App() {
  useEffect(() => {
    const editor = new EditorJS({
      holder: 'editorjs',
      tools: {
        audio: {
          class: AudioTool,
          config: {
            endpointUrl: 'http://localhost:8080/upload',
          },
        },
      },
    })
    return () => editor.destroy()
  }, [])

  return <div id='editorjs'></div>
}

export default App

For Vue3

npm i  editorjs-audio-tool

example

<template>
    <div id='editorjs'></div>
</template>    
<script setup>
import { mounted, unmounted,ref } from 'vue'
import AudioTool from 'editorjs-audio-tool'
import EditorJS from '@editorjs/editorjs'
import 'editorjs-audio-tool/dist/style.css'
let editor = null
mounted(()=>{
     editor = new EditorJS({
      holder: 'editorjs',
      tools: {
        audio: {
          class: AudioTool,
          config: {
            endpointUrl: 'http://localhost:8080/upload',
          },
        },
      },
    })
})

unmounted(()=>{
  editor.destroy()
})

For Static web

<body>
    <script src="https://cdn.jsdelivr.net/npm/@editorjs/editorjs@latest"></script>
     <script src="https://cdn.jsdelivr.net/npm/editorjs-audio-tool@latest"></script>
    <div id="editorjs"></div>
    <script>
        const editor = new EditorJS({
            tools: {
                audio: {
                    class: AudioTool,
                    config: {
                        endpointUrl: "http://localhost:8080/upload",
                    }
                }
            },
            holder: "editorjs"
        });
    </script>
</body>

API

Module config.
NameTypeDescription
endpointUrlStringUrl endpoint to upload file to
dowloadableBooleanSet if audio display will have download button
requestParserFunc(FetchRequestObject):FetchRequestObjectfunction to modify upload request before send
respondParserFunc(FetchRespondObject):FetchRespondObjectfunction to modify upload respond before display in block
onDeleteFunc(EditorJSBlockObject)this function is called after deleted
  • EditorJSBlockObject - editor js block object that consist of block id and others data

  • FetchRequestObject - It is object that will be pass to fetch api function

  • FetchRespondObject - It is object respond from uploading file with fetch api

Module data
NameTypeDescription
urlstringURL of the audio file
typestringthis is mime type of the audio file such as "audio/mpeg3"