Security News
How Threat Actors are Abusing GitHub’s File Upload Feature to Host Malware
GitHub is susceptible to a CDN flaw that allows attackers to host malware on any public repository.
rc-mentions
Advanced tools
Package description
The rc-mentions npm package is designed to provide a React component for implementing mention features within applications. It allows users to easily mention people, tags, or other entities in text inputs or textareas by typing a trigger character (like '@') followed by a list of suggestions.
Basic Mentioning
This feature allows for basic mentioning functionality where users can type '@' followed by a list of predefined suggestions. The code sample demonstrates how to set up a basic Mention component with a default value and a list of suggestions.
import React from 'react';
import Mention from 'rc-mentions';
const { Option } = Mention;
function App() {
return (
<Mention
style={{ width: '100%' }}
defaultValue="@afc163"
suggestions={['afc163', 'benjycui', 'yiminghe', 'RaoHai', '中文', 'にほんご']}
/>
);
}
Custom Trigger
This feature allows users to customize the trigger character for mentions. In this example, both '@' and '#' are set as triggers, enabling mentions for users as well as tags or other entities.
import React from 'react';
import Mention from 'rc-mentions';
const { Option } = Mention;
function App() {
return (
<Mention
style={{ width: '100%' }}
prefix={['@', '#']}
suggestions={['afc163', 'benjycui', 'yiminghe', 'RaoHai', '中文', 'にほんご']}
/>
);
}
Custom Render
This feature allows for custom rendering of suggestions. The code sample shows how to use the Option component to customize how suggestions are displayed, providing more flexibility in the presentation of suggestions.
import React from 'react';
import Mention from 'rc-mentions';
const { Option } = Mention;
function App() {
return (
<Mention
style={{ width: '100%' }}
suggestions={['afc163', 'benjycui', 'yiminghe', 'RaoHai', '中文', 'にほんご'].map(value => (
<Option key={value} value={value}>
{value}
</Option>
))}
/>
);
}
react-mentions is another popular package for implementing mentions in React applications. It offers similar functionalities to rc-mentions, such as customizable triggers and rendering options. However, react-mentions might provide a different API or additional features like asynchronous loading of suggestions.
This package is a plugin for the Draft.js framework, designed to add mention capabilities to rich text editors built with Draft.js. While it serves a similar purpose to rc-mentions, draft-js-mention-plugin is specifically tailored for Draft.js editors and offers deep integration with the Draft.js ecosystem.
Readme
/**
* inline: true
*/
import Mentions from 'rc-mentions';
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);
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 | ' ' |
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
online example: http://react-component.github.io/mentions/
npm test
npm run coverage
rc-mentions is released under the MIT license.
FAQs
React Mentions
The npm package rc-mentions receives a total of 968,056 weekly downloads. As such, rc-mentions popularity was classified as popular.
We found that rc-mentions demonstrated a healthy version release cadence and project activity because the last version was released less than a year ago. It has 3 open source maintainers collaborating on the project.
Did you know?
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.
Security News
GitHub is susceptible to a CDN flaw that allows attackers to host malware on any public repository.
Security News
At Node Congress, Socket CEO Feross Aboukhadijeh uncovers the darker aspects of open source, where applications that rely heavily on third-party dependencies can be exploited in supply chain attacks.
Research
Security News
The Socket Research team found this npm package includes code for collecting sensitive developer information, including your operating system username, Git username, and Git email.