uxcore-mention v0.4.5

uxcore-mention

React mention. Mention anywhere.

Development

git clone https://github.com/uxcore/uxcore-mention
cd uxcore-mention
npm install
npm run server

if you'd like to save your install time，you can use uxcore-tools globally.

npm install uxcore-tools -g
git clone https://github.com/uxcore/uxcore-mention
cd uxcore-mention
npm install
npm run dep
npm run start

Test Case

npm run test

Coverage

npm run coverage

Demo

http://uxcore.github.io/components/mention

If you are running this demo in some old browsers that do not support getSelection(), you may need to include rangy in your page.

work width all kinds of editor

import ReactDOM from 'react-dom';
import Tinymce from 'uxcore-tinymce';
import Mention, { ContenteditableEditor, TextareaEditor, InputEditor } from 'uxcore-mention';

ReactDOM.render(
  <div>
    <Mention
        source={source}
        formatter={formatter}>
        <ContenteditableEditor
          width={250}
          height={150}
          placeholder="contenteditable editor placeholder" />
        <TextareaEditor
          width={250}
          height={100}
          placeholder="textarea editor placeholder" />
        <InputEditor
          placeholder="input editor placeholder" />
    </Mention>
  </div>
  ,targetNode);

work with tinymce

import ReactDOM from 'react-dom';
import Tinymce from 'uxcore-tinymce';
import Mention, { TinymceMention } from 'uxcore-mention';

ReactDOM.render(
  <div>
    <TinymceMention
          insertMode={'TEXT_NODE'}
          source={getData}
          formatter={dataFormatter}
          mentionFormatter={mentionFormatter}
          panelFormatter={panelFormatter}>
          <Tinymce
              placeholder={'tinymce placeholder'} />
      </TinymceMention>
  </div>
  ,targetNode);

Contribute

Yes please! See the CONTRIBUTING for details.

API

Mention

• formatter(arr): format the data form source.
• panelFormatter(obj): customize the panel display.
• onChange(e, value): onChange事件。

TinymceMention

• formatter(arr): format the data form source.
• panelFormatter(obj): customize the panel display.
• mentionFormatter(obj): customize the insert content with this function.
• onChange(e, value): Callback invoked when the editor's content has been changed.
• onAdd(display, originData): Callback invoked when a mention has been added.

ContentEditableEditor

• mentionFormatter(obj): customize the insert content with this function.
• onChange(e, value): Callback invoked when the editor's content has been changed.
• onAdd(display, originData): Callback invoked when a mention has been added.
• getMentions(): get all current mentions(will automatically remove duplicate items).

TextareaEditor

• mentionFormatter(obj): customize the insert content with this function.
• onChange(e, value): Callback invoked when the editor's content has been changed.
• onAdd(display, originData): Callback invoked when a mention has been added.
• getMentions(): get all current mentions(will automatically remove duplicate items).

InputEditor

• mentionFormatter(obj): customize the insert content with this function.
• onChange(e, value): Callback invoked when the editor's content has been changed.
• onAdd(display, originData): Callback invoked when a mention has been added.
• getMentions(): get all current mentions(will automatically remove duplicate items).

props

Mention

TinymceMention

ContentEditableEditor

TextareaEditor

InputEditor