Huge News!Announcing our $40M Series B led by Abstract Ventures.Learn More
Socket
Sign inDemoInstall
Socket

@botmock/react-mentions

Package Overview
Dependencies
Maintainers
5
Versions
1
Alerts
File Explorer

Advanced tools

Socket logo

Install Socket

Detect and block malicious and high-risk dependencies

Install

@botmock/react-mentions

React mentions input

  • 0.0.0-development
  • latest
  • Source
  • npm
  • Socket score

Version published
Weekly downloads
0
decreased by-100%
Maintainers
5
Weekly downloads
 
Created
Source

React Mentions

CircleCI codecov npm package semantic-release

A React component that let's you mention people in a textarea like you are used to on Facebook or Twitter.

Used in production at Signavio, State, Snips, Swat.io, GotDone, Volinspire, Marvin, Timely, GuideFitter, Evite, Publer, Kontentino, and you?

Getting started

Install the react-mentions package via npm:

npm install react-mentions --save

Or yarn:

yarn add react-mentions

The package exports two React components for rendering the mentions textarea:

import { MentionsInput, Mention } from 'react-mentions'

MentionsInput is the main component rendering the textarea control. It takes one or multiple Mention components as its children. Each Mention component represents a data source for a specific class of mentionable objects, such as users, template variables, issues, etc.

Example:

<MentionsInput value={this.state.value} onChange={this.handleChange}>
  <Mention
    trigger="@"
    data={this.props.users}
    renderSuggestion={this.renderUserSuggestion}
  />
  <Mention
    trigger="#"
    data={this.requestTag}
    renderSuggestion={this.renderTagSuggestion}
  />
</MentionsInput>

You can find more examples here: demo/src/examples

Configuration

The MentionsInput supports the following props for configuring the widget:

Prop nameTypeDefault valueDescription
valuestring''The value containing markup for mentions
onChangefunction (event, newValue, newPlainTextValue, mentions)empty functionA callback that is invoked when the user changes the value in the mentions input
singleLinebooleanfalseRenders a single line text input instead of a textarea, if set to true
onBlurfunction (event, clickedSuggestion)empty functionPasses true as second argument if the blur was caused by a mousedown on a suggestion
allowSpaceInQuerybooleanfalseKeep suggestions open even if the user separates keywords with spaces.
suggestionsPortalHostDOM ElementundefinedRender suggestions into the DOM in the supplied host element.
inputRefReact refundefinedAccepts a React ref to forward to the underlying input element
allowSuggestionsAboveCursorbooleanfalseRenders the SuggestionList above the cursor if there is not enough space below

Each data source is configured using a Mention component, which has the following props:

Prop nameTypeDefault valueDescription
triggerregexp or string'@'Defines the char sequence upon which to trigger querying the data source
dataarray or function (search, callback)nullAn array of the mentionable data entries (objects with id & display keys, or a filtering function that returns an array based on a query parameter
renderSuggestionfunction (entry, search, highlightedDisplay, index, focused)nullAllows customizing how mention suggestions are rendered (optional)
markupstring'@[__display__](__id__)'A template string for the markup to use for mentions
displayTransformfunction (id, display)returns displayAccepts a function for customizing the string that is displayed for a mention
regexRegExpautomatically derived from markup patternAllows providing a custom regular expression for parsing your markup and extracting the placeholder interpolations (optional)
onAddfunction (id, display)empty functionCallback invoked when a suggestion has been added (optional)
appendSpaceOnAddbooleanfalseAppend a space when a suggestion has been added (optional)

If a function is passed as the data prop, that function will be called with the current search query as first, and a callback function as second argument. The callback can be used to provide results asynchronously, e.g., after fetch requests. (It can even be called multiple times to update the list of suggestions.)

Styling

react-mentions supports css, css modules, and inline styles. It is shipped with only some essential inline style definitions and without any css. Some example inline styles demonstrating how to customize the appearance of the MentionsInput can be found at demo/src/examples/defaultStyle.js.

If you want to use css, simply assign a className prop to MentionsInput. All DOM nodes rendered by the component will then receive class name attributes that are derived from the base class name you provided.

If you want to avoid global class names and use css modules instead, you can provide the automatically generated class names as classNames to the MentionsInput. See demo/src/examples/CssModules.js for an example of using react-mentions with css modules.

You can also assign className and style props to the Mention elements to define how to highlight the mentioned words.

Contributing

Spawn a development server with an example page and module hot loading all set up:

npm start

Update the examples page on Github Pages:

npm run pages-publish

Keywords

FAQs

Package last updated on 21 Dec 2020

Did you know?

Socket

Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.

Install

Related posts

SocketSocket SOC 2 Logo

Product

  • Package Alerts
  • Integrations
  • Docs
  • Pricing
  • FAQ
  • Roadmap
  • Changelog

Packages

npm

Stay in touch

Get open source security insights delivered straight into your inbox.


  • Terms
  • Privacy
  • Security

Made with ⚡️ by Socket Inc