# editor-mention

> Mention Tool for Editor.js

Latest version **0.0.1** (published 2021-02-04) · MIT license · 0 weekly downloads

## Install

```sh
npm install editor-mention
pnpm add editor-mention
yarn add editor-mention
bun add editor-mention
```

## Health

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

Positive: no vulnerabilities.

Warnings: low downloads; no types; no esm support; pre 1.0.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 0.0.1 |
| Published | 2021-02-04 |
| First published | 2021-02-04 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 0 |
| Unpacked size | 28.8 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 1 |
| Author | sainisagar310 |
| Maintainers | sainisagar310 |
| Keywords | codex editor, tool, code, editor.js, editorjs |

## Links

- npm: https://www.npmjs.com/package/editor-mention
- Repository: https://github.com/sainisagar310/editor-mention
- Homepage: https://github.com/sainisagar310/editor-mention#readme
- Issues: https://github.com/sainisagar310/editor-mention/issues
- npm.io page: https://npm.io/package/editor-mention

## Alternatives

- [flatbuffers](https://npm.io/package/flatbuffers.md) — 6.0M weekly downloads
- [jwt-simple](https://npm.io/package/jwt-simple.md) — 259.5K weekly downloads
- [@exodus/patch-broken-hermes-typed-arrays](https://npm.io/package/@exodus/patch-broken-hermes-typed-arrays.md) — 28.5K weekly downloads
- [@native-to-anchor/buffer-layout](https://npm.io/package/@native-to-anchor/buffer-layout.md) — 12.2K weekly downloads
- [binary-parser-encoder](https://npm.io/package/binary-parser-encoder.md) — 5.3K weekly downloads

## Recent versions

- 0.0.1 (latest) — 2021-02-04

## README

# Mention Tool

Provides Code Blocks for the [Editor.js](https://editorjs.io).

![image](https://user-images.githubusercontent.com/6184465/65400436-c0ec9680-ddf4-11e9-9b18-6820a436d9c1.png)


## Installation

### Install via NPM

Get the package

```shell
npm i --save-dev @groupher/editor-mention
```

Include module at your application

```javascript
const Mention = require('@groupher/editor-mention');
```

### Download to your project's source dir

1. Upload folder `dist` from repository
2. Add `dist/bundle.js` file to your page.

## Usage

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

```javascript
var editor = EditorJS({
  ...
  
  tools: {
    ...
    mention: Mention,
  },
  
  ...
});
```

## Output data

| Field     | Type     | Description          |
| --------- | -------- | -------------------- |
| text      | `string` | code's text         |


```json
{
    "type" : "text",
    "data" : {
        "text" : "hello <span class=\"cdx-mention\">mydearxym</span>"
    }
}
```

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