# editorjs-audio-tool

> Audio Tool for Editor.js

Latest version **1.0.1** (published 2022-05-10) · MIT license · 0 weekly downloads

## Install

```sh
npm install editorjs-audio-tool
pnpm add editorjs-audio-tool
yarn add editorjs-audio-tool
bun add editorjs-audio-tool
```

## Health

**Score 20/100 (F)** — status: abandoned.

Positive: esm support; no vulnerabilities.

Warnings: low downloads; no types.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 1.0.1 |
| Published | 2022-05-10 |
| First published | 2022-05-10 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | ESM + CommonJS |
| Dependencies | 0 |
| Unpacked size | 13.1 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 4 |
| Author | chenguzhen87 |
| Maintainers | chenguzhen87 |
| Keywords | codex editor, tool, video, editor.js, editorjs |

## Links

- npm: https://www.npmjs.com/package/editorjs-audio-tool
- Repository: https://github.com/chenguzhen87/editorjs-audio-tool
- Homepage: https://github.com/chenguzhen87/editorjs-audio-tool#readme
- Issues: https://github.com/chenguzhen87/editorjs-audio-tool.git/issues
- npm.io page: https://npm.io/package/editorjs-audio-tool

## Alternatives

- [@sindresorhus/slugify](https://npm.io/package/@sindresorhus/slugify.md) — 3.7M weekly downloads
- [solid-js](https://npm.io/package/solid-js.md) — 2.7M weekly downloads
- [expo-glass-effect](https://npm.io/package/expo-glass-effect.md) — 2.5M weekly downloads
- [nanoassert](https://npm.io/package/nanoassert.md) — 780.8K weekly downloads
- [@ffmpeg/ffmpeg](https://npm.io/package/@ffmpeg/ffmpeg.md) — 529.5K weekly downloads

## Recent versions

- 1.0.1 (latest) — 2022-05-10
- 1.0.0 — 2022-05-10

## README

#  editorjs-audio-tool

Audio Tool for Editor.js

## Install

#### For React

```bash
npm i  editorjs-audio-tool
```

example

```js
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

```bash
npm i  editorjs-audio-tool
```

example

```js
<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

```html
<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.

| Name          | Type                                        | Description                                               |
| ------------- | ------------------------------------------- | --------------------------------------------------------- |
| endpointUrl   | String                                      | Url endpoint to upload file to                            |
| dowloadable   | Boolean                                     | Set if audio display will have download button            |
| requestParser | Func(FetchRequestObject):FetchRequestObject | function to modify upload request before send             |
| respondParser | Func(FetchRespondObject):FetchRespondObject | function to modify upload respond before display in block |
| onDelete      | Func(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

| Name | Type   | Description                                               |
| ---- | ------ | --------------------------------------------------------- |
| url  | string | URL of the audio file                                     |
| type | string | this is mime type of the audio file such as "audio/mpeg3" |

---
_Source: https://npm.io/package/editorjs-audio-tool · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._