Files
outline/app/hooks/useTemplateMenuActions.tsx
Hemachandar 4822261187 chore: Move DocumentMenu to Radix (#9879)
* works without custom items in menu

* tooltip support for dropdown button

* fix: menu goes out of bounds

* custom node, lazy render menu for perf

* bug fixes

* fix: useTemplateActions re-computed templates on every render

* fix: hide subscribe/unsubscribe for inactive documents & collections

* cleanup `MenuContext` & `useTemplateMenuItems`

* rename prop, increase dropdown max-height

* jsdoc
2025-08-09 18:11:20 +05:30

91 lines
2.7 KiB
TypeScript

import { DocumentIcon } from "outline-icons";
import { useCallback } from "react";
import { useTranslation } from "react-i18next";
import Icon from "@shared/components/Icon";
import { TextHelper } from "@shared/utils/TextHelper";
import Document from "~/models/Document";
import {
ActionV2Separator,
createActionV2,
createActionV2Group,
} from "~/actions";
import { DocumentsSection } from "~/actions/sections";
import useCurrentUser from "~/hooks/useCurrentUser";
import useStores from "~/hooks/useStores";
import { ActionV2 } from "~/types";
import { useComputed } from "./useComputed";
type Props = {
/** The document to which the templates will be applied */
document: Document;
/** Callback to handle when a template is selected */
onSelectTemplate?: (template: Document) => void;
};
/**
* This hook provides a memoized list of actions for both collection-specific
* templates and workspace-wide templates. It filters templates based on whether
* they are published and organizes them into appropriate sections.
*
* Collection-specific templates are displayed first, followed by workspace templates
* with a separator in between (if both types exist).
*
* @returns An array of Action objects representing templates that can be applied
* to the current document. Returns an empty array if no callback is provided.
*/
export function useTemplateMenuActions({ document, onSelectTemplate }: Props) {
const user = useCurrentUser();
const { documents } = useStores();
const { t } = useTranslation();
const templateToAction = useCallback(
(template: Document): ActionV2 =>
createActionV2({
name: TextHelper.replaceTemplateVariables(
template.titleWithDefault,
user
),
section: DocumentsSection,
icon: template.icon ? (
<Icon value={template.icon} color={template.color ?? undefined} />
) : (
<DocumentIcon />
),
visible: true,
perform: () => onSelectTemplate?.(template),
}),
[user, onSelectTemplate]
);
return useComputed(() => {
if (!onSelectTemplate) {
return [];
}
const templates = documents.templates.filter(
(template) => template.publishedAt
);
const collectionTemplatesActions = templates
.filter(
(template) =>
!template.isWorkspaceTemplate &&
template.collectionId === document.collectionId
)
.map(templateToAction);
const workspaceTemplatesActions = templates
.filter((tmpl) => tmpl.isWorkspaceTemplate)
.map(templateToAction);
return [
...collectionTemplatesActions,
ActionV2Separator,
createActionV2Group({
name: t("Workspace"),
actions: workspaceTemplatesActions,
}),
];
}, []);
}