https://github.com/react-component/editor-mention
React Mention
https://github.com/react-component/editor-mention
Last synced: 4 months ago
JSON representation
React Mention
- Host: GitHub
- URL: https://github.com/react-component/editor-mention
- Owner: react-component
- License: mit
- Created: 2016-05-27T10:32:37.000Z (over 9 years ago)
- Default Branch: master
- Last Pushed: 2021-06-28T21:14:46.000Z (over 4 years ago)
- Last Synced: 2025-08-05T10:46:08.431Z (5 months ago)
- Language: JavaScript
- Homepage: http://react-component.github.io/editor-mention/
- Size: 6.27 MB
- Stars: 54
- Watchers: 6
- Forks: 22
- Open Issues: 18
-
Metadata Files:
- Readme: README.md
- Changelog: HISTORY.md
- License: LICENSE.md
Awesome Lists containing this project
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 | 
Firefox | 
Chrome | 
Safari | 
iOS Safari | 
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
![]()
## 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
[](https://npmjs.org/package/rc-editor-mention)
## Usage
```js
var Mention = require('rc-editor-mention');
var React = require('react');
React.render(, container);
```
## API
### props
name
type
default
description
className
String
additional css class of root dom node
placement
String
"bottom"
suggestion placement, available values: "top", "bottom"
## 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.