# rc-editor-mention

> mention ui component for react

Latest version **1.1.13** (published 2019-05-20) · 0 weekly downloads

## Install

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

## 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.1.13 |
| Published | 2019-05-20 |
| First published | 2016-05-27 |
| Weekly downloads | 0 |
| TypeScript types | none |
| Module format | ESM + CommonJS |
| Dependencies | 8 |
| Unpacked size | 107.3 KB |
| Known vulnerabilities | 0 (+3 in 1 direct dependencies) |
| Install scripts | no |
| GitHub stars | 55 |
| Author | surgesoft@gmail.com |
| Maintainers | afc163, mrpeak, raohai |
| Keywords | react, react-component, react-mention, mention |

## Links

- npm: https://www.npmjs.com/package/rc-editor-mention
- Repository: https://github.com/react-component/mention
- Issues: https://github.com/react-component/mention/issues
- npm.io page: https://npm.io/package/rc-editor-mention

## Dependencies (8)

- [draft-js](https://npm.io/package/draft-js.md) ~0.10.0
- [immutable](https://npm.io/package/immutable.md) ~3.7.4
- [classnames](https://npm.io/package/classnames.md) ^2.2.5
- [prop-types](https://npm.io/package/prop-types.md) ^15.5.8
- [rc-animate](https://npm.io/package/rc-animate.md) ^2.3.0
- [babel-runtime](https://npm.io/package/babel-runtime.md) ^6.23.0
- [rc-editor-core](https://npm.io/package/rc-editor-core.md) ~0.8.3
- [dom-scroll-into-view](https://npm.io/package/dom-scroll-into-view.md) ^1.2.0

## Alternatives

- [mobx-react](https://npm.io/package/mobx-react.md) — 2.8M weekly downloads
- [rc-tree](https://npm.io/package/rc-tree.md) — 2.6M weekly downloads
- [@react-oauth/google](https://npm.io/package/@react-oauth/google.md) — 1.3M weekly downloads
- [@wagmi/connectors](https://npm.io/package/@wagmi/connectors.md) — 877.0K weekly downloads
- [vee-validate](https://npm.io/package/vee-validate.md) — 836.4K weekly downloads

## Recent versions

- 1.1.13 (latest) — 2019-05-20
- 1.1.2-beta1 (beta) — 2017-11-28
- 1.1.12 — 2018-11-28
- 1.1.11 — 2018-11-19
- 1.1.10 — 2018-11-14
- 1.1.9 — 2018-11-05
- 1.1.8 — 2018-10-19
- 1.1.7 — 2018-05-22
- 1.1.6 — 2018-02-09
- 1.1.5 — 2018-02-06
- 1.1.4 — 2018-01-01
- 1.1.3 — 2017-12-29
- 0.6.14 — 2017-12-29
- 1.1.1 — 2017-11-28
- 1.0.3 — 2017-10-16
- … 90 more at https://npm.io/package/rc-editor-mention/versions

## README

# rc-editor-mention
---

React Mention Component


[![NPM version][npm-image]][npm-url]
[![build status][travis-image]][travis-url]
[![Test coverage][coveralls-image]][coveralls-url]
[![gemnasium deps][gemnasium-image]][gemnasium-url]
[![node version][node-image]][node-url]
[![npm download][download-image]][download-url]

[npm-image]: http://img.shields.io/npm/v/rc-editor-mention.svg?style=flat-square
[npm-url]: http://npmjs.org/package/rc-editor-mention
[travis-image]: https://img.shields.io/travis/react-component/editor-mention.svg?style=flat-square
[travis-url]: https://travis-ci.org/react-component/editor-mention
[coveralls-image]: https://img.shields.io/coveralls/react-component/editor-mention.svg?style=flat-square
[coveralls-url]: https://coveralls.io/r/react-component/editor-mention?branch=master
[gemnasium-image]: http://img.shields.io/gemnasium/react-component/editor-mention.svg?style=flat-square
[gemnasium-url]: https://gemnasium.com/react-component/editor-mention
[node-image]: https://img.shields.io/badge/node.js-%3E=_0.10-green.svg?style=flat-square
[node-url]: http://nodejs.org/download/
[download-image]: https://img.shields.io/npm/dm/rc-editor-mention.svg?style=flat-square
[download-url]: https://npmjs.org/package/rc-editor-mention


## Browser Support
## Browser Support

| ![IE / Edge](https://raw.githubusercontent.com/godban/browsers-support-badges/master/src/images/edge.png) <br /> IE / Edge | ![Firefox](https://raw.githubusercontent.com/godban/browsers-support-badges/master/src/images/firefox.png) <br /> Firefox | ![Chrome](https://raw.githubusercontent.com/godban/browsers-support-badges/master/src/images/chrome.png) <br /> Chrome | ![Safari](https://raw.githubusercontent.com/godban/browsers-support-badges/master/src/images/safari.png ) <br /> Safari | ![iOS Safari](https://raw.githubusercontent.com/godban/browsers-support-badges/master/src/images/safari-ios.png) <br />iOS Safari | ![Chrome for Anroid](https://raw.githubusercontent.com/godban/browsers-support-badges/master/src/images/chrome-android.png) <br/> Chrome for Android |
| --------- | --------- | --------- | --------- | --------- | --------- |
| IE11, Edge [1, 2]| last 2 versions| last 2 versions| last 2 versions| not fully supported [3] | not fully supported [3]

[1] May need a shim or a polyfill for some syntax used in Draft.js ([docs](https://draftjs.org/docs/advanced-topics-issues-and-pitfalls.html#polyfills)). 

[2] IME inputs have known issues in these browsers, especially Korean ([docs](https://draftjs.org/docs/advanced-topics-issues-and-pitfalls.html#ime-and-internet-explorer)).

[3] There are known issues with mobile browsers, especially on Android ([docs](https://draftjs.org/docs/advanced-topics-issues-and-pitfalls.html#mobile-not-yet-supported)).


## Screenshots

<img src="" width="288"/>


## Development

```
npm install
npm start
```

## Example

http://localhost:8001/examples/


online example: http://react-component.github.io/editor-mention/


## Feature

* support ie8,ie8+,chrome,firefox,safari


## install


[![rc-editor-mention](https://nodei.co/npm/rc-editor-mention.png)](https://npmjs.org/package/rc-editor-mention)


## Usage

```js
var Mention = require('rc-editor-mention');
var React = require('react');
React.render(<Mention />, container);
```

## API

### props

<table class="table table-bordered table-striped">
    <thead>
    <tr>
        <th style="width: 100px;">name</th>
        <th style="width: 50px;">type</th>
        <th style="width: 50px;">default</th>
        <th>description</th>
    </tr>
    </thead>
    <tbody>
        <tr>
          <td>className</td>
          <td>String</td>
          <td></td>
          <td>additional css class of root dom node</td>
        </tr>
        <tr>
          <td>placement</td>
          <td>String</td>
          <td>"bottom"</td>
          <td>suggestion placement, available values: "top", "bottom"</td>
        </tr>
    </tbody>
</table>


## Test Case

```
npm test
npm run chrome-test
```

## Coverage

```
npm run coverage
```

open coverage/ dir

## License

rc-editor-mention is released under the MIT license.

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