[FEATURE] Enabled User @mentions and @mention-filters in core editor package
#2544
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
|
The latest updates on your projects. Learn more about Vercel for Git ↗︎ 6 Ignored Deployments
|
henit-chobisa
changed the title
@mentions in tiptap editor component@mentions and @mention-filters in core editor package
henit-chobisa
added
🌟enhancement
pablohashescobar
requested changes
Oct 30, 2023
henit-chobisa
force-pushed
the
feat/editor-mentions
branch
from
ffa6b66
to
6ae278e
Compare
pablohashescobar
requested changes
Oct 30, 2023
pablohashescobar
approved these changes
Oct 31, 2023
1 task
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Description
The current pull request enables the usage of
user-mentionsin the tiptap editor, with features such as self highlighting, redirection and sending notifications from the backend.Features
Sending Notification on being mentioned with context of being mentioned
Irrespective of a person being a subscriber of the issue or not, if he's mentioned in a particular issue, he will be sent a notification for being mentioned, along with that he will be added as a subscriber to the issue, to receive further updates on the issue. For testing the possible set of cases and scenarios please go through https://henit.notion.site/feat-mentions-c96dc6cfe53a4e2eafb0acb252cb80c4?pvs=4
Redirecting on the user profile, when clicked on the mention
The mention acts as a button, hence if you have provided the
redirect_uriin the underlying data structureIMentionSuggestion[], you can see it redirecting to the user's profile. In future we can use this for redirecting to specific sets of views such as cycles or issues itself.Screen.Recording.2023-10-03.at.5.36.15.PM.mov
Dynamic Highlights of entities in an issue
The mention feature also come with highlightin, which makes it extremely easy to spot a particular highlight, which can be anything from highlighting the current user from the content or highlighting a set of issues from a query of "Show me all the issues where a particular set of issues are mentioned". Currently the highlighting works only in the
issues/form.tsx, and inside-peak-view.For Example: : If the highlight group is for the current user, which means that in every issue, if the current user is mentioned he must be highlighted, in this case it's dynamic because for an issue where
@crewand@captainboth are mentioned, if@crewis signed in, he must be highlighted and so as captain, which makes us dynamically update the values. Below is the picture of the implementation, which show how dynamic highlights work for two different highlight groups.Issue View of the Captain
Issue View for the Crew
Issue filters with Embedded Mentions
Many of the times, customers tend to search for the issues where they are mentioned or maybe a particular issue or a person is mentioned, apps such as slack provide such functionality to quickly grab through text messages, which has been very convenient, hence along with the ability to tag people, I have also added an ability to filter issues according to the mentioned users.
Screen.Recording.2023-10-30.at.6.07.30.PM.mov