rc-mentions
Version:
137 lines (104 loc) • 8.13 kB
Markdown
[![NPM version][npm-image]][npm-url]
[![npm download][download-image]][download-url]
[![build status][github-actions-image]][github-actions-url]
[![Codecov][codecov-image]][codecov-url]
[![bundle size][bundlephobia-image]][bundlephobia-url]
[![dumi][dumi-image]][dumi-url]
[]: http://img.shields.io/npm/v/rc-mentions.svg?style=flat-square
[]: http://npmjs.org/package/rc-mentions
[]: https://img.shields.io/travis/react-component/mentions/master?style=flat-square
[]: https://travis-ci.com/react-component/mentions
[]: https://github.com/react-component/mentions/workflows/CI/badge.svg
[]: https://github.com/react-component/mentions/actions
[]: https://img.shields.io/codecov/c/github/react-component/mentions/master.svg?style=flat-square
[]: https://app.codecov.io/gh/react-component/mentions
[]: https://david-dm.org/react-component/mentions
[]: https://david-dm.org/react-component/mentions/status.svg?style=flat-square
[]: https://david-dm.org/react-component/mentions?type=dev
[]: https://david-dm.org/react-component/mentions/dev-status.svg?style=flat-square
[]: https://img.shields.io/npm/dm/rc-mentions.svg?style=flat-square
[]: https://npmjs.org/package/rc-mentions
[]: https://bundlephobia.com/package/rc-mentions
[]: https://badgen.net/bundlephobia/minzip/rc-mentions
[]: https://github.com/umijs/dumi
[]: https://img.shields.io/badge/docs%20by-dumi-blue?style=flat-square
<img src="https://user-images.githubusercontent.com/5378891/57270992-2fd48780-70c0-11e9-91ae-c614d0b49a45.png" />
- support ie9,ie9+,chrome,firefox,safari
- Open mentions (focus input || focus and click)
- KeyDown/KeyUp/Enter to navigate menu
## install
[](https://npmjs.org/package/rc-mentions)
## Usage
### basic use
```js
/**
* inline: true
*/
import Mentions from 'rc-mentions';
// Import the default styles
import './index.less';
const { Option } = Mentions;
var Demo = (
<Mentions>
<Option value="light">Light</Option>
<Option value="bamboo">Bamboo</Option>
<Option value="cat">Cat</Option>
</Mentions>
);
React.render(<Demo />, container);
```
**Note:** We use [index.less](https://github.com/react-component/mentions/blob/master/assets/index.less) for styling, you can convert them into css and properly reference them to the code above.
| name | description | type | default |
| ----------------- | ------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------- | ----------- |
| autoFocus | Auto get focus when component mounted | `boolean` | `false` |
| defaultValue | Default value | `string` | - |
| filterOption | Customize filter option logic | `false \| (input: string, option: OptionProps) => boolean` | - |
| notFoundContent | Set mentions content when not match | `ReactNode` | 'Not Found' |
| placement | Set popup placement | `'top' \| 'bottom'` | 'bottom' |
| direction | Set popup direction | `'ltr' \| 'rtl'` | 'ltr' |
| prefix | Set trigger prefix keyword | `string \| string[]` | '@' |
| rows | Set row count | `number` | 1 |
| split | Set split string before and after selected mention | `string` | ' ' |
| silent | Used in transition phase, does not respond to keyboard enter events when equal to `true` | `boolean` | `false` |
| validateSearch | Customize trigger search logic | `(text: string, props: MentionsProps) => void` | - |
| value | Set value of mentions | `string` | - |
| onChange | Trigger when value changed | `(text: string) => void` | - |
| onKeyDown | Trigger when user hits a key | `React.KeyboardEventHandler<HTMLTextAreaElement>` | - |
| onKeyUp | Trigger when user releases a key | `React.KeyboardEventHandler<HTMLTextAreaElement>` | - |
| onSelect | Trigger when user select the option | `(option: OptionProps, prefix: string) => void` | - |
| onSearch | Trigger when prefix hit | `(text: string, prefix: string) => void` | - |
| onFocus | Trigger when mentions get focus | `React.FocusEventHandler<HTMLTextAreaElement>` | - |
| onBlur | Trigger when mentions lose focus | `React.FocusEventHandler<HTMLTextAreaElement>` | - |
| getPopupContainer | DOM Container for suggestions | `() => HTMLElement` | - |
| autoSize | Textarea height autosize feature, can be set to `true\|false` or an object `{ minRows: 2, maxRows: 6 }` | `boolean \| object` | - |
| onPressEnter | The callback function that is triggered when Enter key is pressed | `function(e)` | - |
| onResize | The callback function that is triggered when textarea resize | `function({ width, height })` | - |
| name | description |
| ------- | -------------------- |
| focus() | Component get focus |
| blur() | Component lose focus |
```
npm install
npm start
```
http://localhost:9001/
online example: http://react-component.github.io/mentions/
```
npm test
```
```
npm run coverage
```
rc-mentions is released under the MIT license.