react-comments-mentions-iamsank8
v2.0.3
Published
React component library for a functioning comments and user mentions
Downloads
123
Readme
react-comments-mentions-iamsank8
Fork maintained at github.com/iamsank8/react-comments-mentions. Node v16+ recommended.
Published as an unscoped name so you can publish with any npm account. Scoped names like @iamsank8/... only work when your npm username matches the scope (GitHub username does not apply).
Install
npm i react-comments-mentions-iamsank8Based off the below package BUT adds gives the ability to add a timestamp to each comment!
react-comments-mentions is a simple but multi-functional react comment section component that helps you create comments section similar to youtube or instagram for your React App.
react-comments-mentions is very useful for react beginners who want a comment section in their project but want to skip it's commplexity. This library will give a fully functional comment section with the following features:
- User can reply to comments
- User can edit his/her comments
- User can delete his/her comments
- User can mention other users in comment
Usage
Hooks Implementation (Typescript)
Following is a basic example to start testing the library in your project. This library works on a user basis system and here are a few important points to remember:
- currentUser[required]. For no user details pass the prop as currentUser={null}
- A new user can be redirected using the login/signup links in the logIn[required] prop.
- The currentData[optional] prop returns an object of current data available after any action such as comment submission, reply, edit or delete.
- The onSubmitAction returns an object of data with the required information to make an API call after a comment is submitted. For more details check out the props list in our detailed documentation. This is how the basic default component would look.
- mentionSuggestions returns user mentions
License
MIT. This project is a fork of work by AkashLakade; see LICENSE for full copyright notices.
