twenty/packages/twenty-front/src/modules/blocknote-editor/components/CustomMentionMenu.tsx
Félix Malfait 6f251a6f8e
Add @mention support in AI Chat input (#17943)
## Summary
- Add `@mention` support to the AI Chat text input by replacing the
plain textarea with a minimal Tiptap editor and building a shared
`mention` module with reusable Tiptap extensions (`MentionTag`,
`MentionSuggestion`), search hook (`useMentionSearch`), and suggestion
menu — all shared with the existing BlockNote-based Notes mentions to
avoid code duplication
- Mentions are serialized as
`[[record:objectName:recordId:displayName]]` markdown (the format
already understood by the backend and rendered in chat messages), and
displayed using the existing `RecordLink` chip component for visual
consistency
- Fix images in chat messages overflowing their container by
constraining to `max-width: 100%`
- Fix web_search tool display showing literal `{query}` instead of the
actual query (ICU single-quote escaping issue in Lingui `t` tagged
templates)

## Test plan
- [ ] Open AI Chat, type `@` and verify the suggestion menu appears with
searchable records
- [ ] Select a mention from the dropdown (via click or keyboard
Enter/ArrowUp/Down) and verify the record chip renders inline
- [ ] Send a message containing a mention and verify it appears
correctly in the conversation as a clickable `RecordLink`
- [ ] Verify Enter sends the message when the suggestion menu is closed,
and selects a mention when the menu is open
- [ ] Verify images in AI chat responses are constrained to the
container width
- [ ] Verify the web_search tool step shows the actual search query
(e.g. "Searched the web for Salesforce") instead of `{query}`
- [ ] Verify Notes @mentions still work as before


Made with [Cursor](https://cursor.com)

---------

Co-authored-by: Cursor <cursoragent@cursor.com>
2026-02-14 14:37:33 +01:00

90 lines
2.9 KiB
TypeScript

import styled from '@emotion/styled';
import { autoUpdate, useFloating } from '@floating-ui/react';
import { motion } from 'framer-motion';
import { type MouseEvent as ReactMouseEvent } from 'react';
import { createPortal } from 'react-dom';
import { MENTION_MENU_DROPDOWN_CLICK_OUTSIDE_ID } from '@/ui/input/constants/MentionMenuDropdownClickOutsideId';
import { MentionMenuListItem } from '@/mention/components/MentionMenuListItem';
import {
type CustomMentionMenuProps,
type MentionItem,
} from '@/blocknote-editor/types/types';
import { DropdownContent } from '@/ui/layout/dropdown/components/DropdownContent';
import { DropdownMenuItemsContainer } from '@/ui/layout/dropdown/components/DropdownMenuItemsContainer';
import { OverlayContainer } from '@/ui/layout/overlay/components/OverlayContainer';
import { isDefined } from 'twenty-shared/utils';
export type { MentionItem };
const MenuPixelWidth = 240;
const StyledContainer = styled.div`
height: 1px;
width: 1px;
`;
export const CustomMentionMenu = ({
items,
selectedIndex,
onItemClick,
}: CustomMentionMenuProps) => {
const { refs, floatingStyles } = useFloating({
placement: 'bottom-start',
whileElementsMounted: autoUpdate,
});
const handleContainerClick = (e: ReactMouseEvent) => {
e.stopPropagation();
};
if (!isDefined(items) || items.length === 0) {
return null;
}
const filteredItems = items.filter(
(item) =>
isDefined(item.recordId) &&
isDefined(item.objectNameSingular) &&
isDefined(item.objectMetadataId),
);
return (
<StyledContainer ref={refs.setReference}>
<>
{createPortal(
<motion.div
initial={{ opacity: 0 }}
animate={{ opacity: 1 }}
transition={{ duration: 0.1 }}
onClick={handleContainerClick}
>
<OverlayContainer
ref={refs.setFloating}
style={floatingStyles}
data-click-outside-id={MENTION_MENU_DROPDOWN_CLICK_OUTSIDE_ID}
>
<DropdownContent widthInPixels={MenuPixelWidth}>
<DropdownMenuItemsContainer hasMaxHeight>
{filteredItems.map((item, index) => (
<MentionMenuListItem
key={item.recordId!}
recordId={item.recordId!}
objectNameSingular={item.objectNameSingular!}
label={item.label ?? item.title}
imageUrl={item.imageUrl ?? ''}
objectLabelSingular={item.objectLabelSingular ?? ''}
isSelected={index === selectedIndex}
onClick={() => onItemClick?.(item)}
/>
))}
</DropdownMenuItemsContainer>
</DropdownContent>
</OverlayContainer>
</motion.div>,
document.body,
)}
</>
</StyledContainer>
);
};