mirror of
https://github.com/outline/outline.git
synced 2026-11-21 13:34:02 +03:00
* feat: init collection mention * refactor: dedicated search helper function for collection mentions * feat: add test for collection search function helper * feat: parseCollectionSlug * feat: isCollectionUrl * feat: add collection mention to paste handler * fix: update translation of mention keyboard shortcut * fix: keyboard shortcut mention label * fix: missing teamId in search helper functioN * chore: update translations --------- Co-authored-by: Tom Moor <tom@getoutline.com>
245 lines
7.0 KiB
TypeScript
245 lines
7.0 KiB
TypeScript
import { isEmail } from "class-validator";
|
|
import { observer } from "mobx-react";
|
|
import { DocumentIcon, PlusIcon, CollectionIcon } from "outline-icons";
|
|
import * as React from "react";
|
|
import { useTranslation } from "react-i18next";
|
|
import { useLocation } from "react-router-dom";
|
|
import { toast } from "sonner";
|
|
import { v4 } from "uuid";
|
|
import Icon from "@shared/components/Icon";
|
|
import { MenuItem } from "@shared/editor/types";
|
|
import { MentionType } from "@shared/types";
|
|
import parseDocumentSlug from "@shared/utils/parseDocumentSlug";
|
|
import { Avatar, AvatarSize } from "~/components/Avatar";
|
|
import Flex from "~/components/Flex";
|
|
import {
|
|
DocumentsSection,
|
|
UserSection,
|
|
CollectionsSection,
|
|
} from "~/actions/sections";
|
|
import useRequest from "~/hooks/useRequest";
|
|
import useStores from "~/hooks/useStores";
|
|
import { client } from "~/utils/ApiClient";
|
|
import SuggestionsMenu, {
|
|
Props as SuggestionsMenuProps,
|
|
} from "./SuggestionsMenu";
|
|
import SuggestionsMenuItem from "./SuggestionsMenuItem";
|
|
|
|
interface MentionItem extends MenuItem {
|
|
attrs: {
|
|
id: string;
|
|
type: MentionType;
|
|
modelId: string;
|
|
label: string;
|
|
actorId?: string;
|
|
};
|
|
}
|
|
|
|
type Props = Omit<
|
|
SuggestionsMenuProps<MentionItem>,
|
|
"renderMenuItem" | "items" | "embeds"
|
|
>;
|
|
|
|
function MentionMenu({ search, isActive, ...rest }: Props) {
|
|
const [loaded, setLoaded] = React.useState(false);
|
|
const [items, setItems] = React.useState<MentionItem[]>([]);
|
|
const { t } = useTranslation();
|
|
const { auth, documents, users, collections } = useStores();
|
|
const actorId = auth.currentUserId;
|
|
const location = useLocation();
|
|
const documentId = parseDocumentSlug(location.pathname);
|
|
const maxResultsInSection = search ? 25 : 5;
|
|
|
|
const { loading, request } = useRequest(
|
|
React.useCallback(async () => {
|
|
const res = await client.post("/suggestions.mention", { query: search });
|
|
|
|
res.data.documents.map(documents.add);
|
|
res.data.users.map(users.add);
|
|
res.data.collections.map(collections.add);
|
|
}, [search, documents, users])
|
|
);
|
|
|
|
React.useEffect(() => {
|
|
if (isActive) {
|
|
void request();
|
|
}
|
|
}, [request, isActive]);
|
|
|
|
React.useEffect(() => {
|
|
if (actorId && !loading) {
|
|
const items = users
|
|
.findByQuery(search, { maxResults: maxResultsInSection })
|
|
.map(
|
|
(user) =>
|
|
({
|
|
name: "mention",
|
|
icon: (
|
|
<Flex
|
|
align="center"
|
|
justify="center"
|
|
style={{ width: 24, height: 24 }}
|
|
>
|
|
<Avatar
|
|
model={user}
|
|
alt={t("Profile picture")}
|
|
size={AvatarSize.Small}
|
|
/>
|
|
</Flex>
|
|
),
|
|
title: user.name,
|
|
section: UserSection,
|
|
appendSpace: true,
|
|
attrs: {
|
|
id: v4(),
|
|
type: MentionType.User,
|
|
modelId: user.id,
|
|
actorId,
|
|
label: user.name,
|
|
},
|
|
} as MentionItem)
|
|
)
|
|
.concat(
|
|
documents
|
|
.findByQuery(search, { maxResults: maxResultsInSection })
|
|
.map(
|
|
(doc) =>
|
|
({
|
|
name: "mention",
|
|
icon: doc.icon ? (
|
|
<Icon value={doc.icon} color={doc.color ?? undefined} />
|
|
) : (
|
|
<DocumentIcon />
|
|
),
|
|
title: doc.title,
|
|
subtitle: doc.collection?.name,
|
|
section: DocumentsSection,
|
|
appendSpace: true,
|
|
attrs: {
|
|
id: v4(),
|
|
type: MentionType.Document,
|
|
modelId: doc.id,
|
|
actorId,
|
|
label: doc.title,
|
|
},
|
|
} as MentionItem)
|
|
)
|
|
)
|
|
.concat(
|
|
collections
|
|
.findByQuery(search, { maxResults: maxResultsInSection })
|
|
.map(
|
|
(collection) =>
|
|
({
|
|
name: "mention",
|
|
icon: collection.icon ? (
|
|
<Icon
|
|
value={collection.icon}
|
|
color={collection.color ?? undefined}
|
|
/>
|
|
) : (
|
|
<CollectionIcon />
|
|
),
|
|
title: collection.name,
|
|
section: CollectionsSection,
|
|
appendSpace: true,
|
|
attrs: {
|
|
id: v4(),
|
|
type: MentionType.Collection,
|
|
modelId: collection.id,
|
|
actorId,
|
|
label: collection.name,
|
|
},
|
|
} as MentionItem)
|
|
)
|
|
)
|
|
.concat([
|
|
{
|
|
name: "link",
|
|
icon: <PlusIcon />,
|
|
title: search?.trim(),
|
|
section: DocumentsSection,
|
|
subtitle: t("Create a new doc"),
|
|
visible: !!search && !isEmail(search),
|
|
priority: -1,
|
|
appendSpace: true,
|
|
attrs: {
|
|
id: v4(),
|
|
type: MentionType.Document,
|
|
modelId: v4(),
|
|
actorId,
|
|
label: search,
|
|
},
|
|
} as MentionItem,
|
|
]);
|
|
|
|
setItems(items);
|
|
setLoaded(true);
|
|
}
|
|
}, [t, actorId, loading, search, users, documents, maxResultsInSection]);
|
|
|
|
const handleSelect = React.useCallback(
|
|
async (item: MentionItem) => {
|
|
if (
|
|
item.attrs.type === MentionType.Document ||
|
|
item.attrs.type === MentionType.Collection
|
|
) {
|
|
return;
|
|
}
|
|
if (!documentId) {
|
|
return;
|
|
}
|
|
// Check if the mentioned user has access to the document
|
|
const res = await client.post("/documents.users", {
|
|
id: documentId,
|
|
userId: item.attrs.modelId,
|
|
});
|
|
|
|
if (!res.data.length) {
|
|
const user = users.get(item.attrs.modelId);
|
|
toast.message(
|
|
t(
|
|
"{{ userName }} won't be notified, as they do not have access to this document",
|
|
{
|
|
userName: item.attrs.label,
|
|
}
|
|
),
|
|
{
|
|
icon: <Avatar model={user} size={AvatarSize.Toast} />,
|
|
duration: 10000,
|
|
}
|
|
);
|
|
}
|
|
},
|
|
[t, users, documentId]
|
|
);
|
|
|
|
// Prevent showing the menu until we have data otherwise it will be positioned
|
|
// incorrectly due to the height being unknown.
|
|
if (!loaded) {
|
|
return null;
|
|
}
|
|
|
|
return (
|
|
<SuggestionsMenu
|
|
{...rest}
|
|
isActive={isActive}
|
|
filterable={false}
|
|
search={search}
|
|
onSelect={handleSelect}
|
|
renderMenuItem={(item, _index, options) => (
|
|
<SuggestionsMenuItem
|
|
onClick={options.onClick}
|
|
selected={options.selected}
|
|
subtitle={item.subtitle}
|
|
title={item.title}
|
|
icon={item.icon}
|
|
/>
|
|
)}
|
|
items={items}
|
|
/>
|
|
);
|
|
}
|
|
|
|
export default observer(MentionMenu);
|