Files
Tom Moor a9428805c1 feat: Show code block toolbar on hover in read-only editors (#14432)
* feat: Show code block toolbar on hover in read-only editors

* fix: Keep hover toolbar while focused, use tap path on touch-only devices
2026-10-31 14:55:04 -04:00

127 lines
3.3 KiB
TypeScript

import { CopyIcon, EditIcon, ExpandedIcon, TextWrapIcon } from "outline-icons";
import type { Node as ProseMirrorNode } from "prosemirror-model";
import { NodeSelection } from "prosemirror-state";
import {
pluginKey as mermaidPluginKey,
type MermaidState,
} from "@shared/editor/extensions/Mermaid";
import {
getFrequentCodeLanguages,
codeLanguages,
getLabelForLanguage,
} from "@shared/editor/lib/code";
import { isMermaid } from "@shared/editor/lib/isCode";
import { t } from "i18next";
import type {
MenuItem,
NodeWithPos,
SelectionContext,
} from "@shared/editor/types";
import { metaDisplay } from "@shared/utils/keyboard";
/**
* Returns menu items for the code block selection toolbar.
*
* @param ctx - the current selection context.
* @param codeBlock - the code block to act on, defaults to the selected one.
* @returns an array of menu items.
*/
export default function codeMenuItems(
ctx: SelectionContext,
codeBlock?: NodeWithPos
): MenuItem[] {
const { state, readOnly } = ctx;
const { selection } = state;
const { node, pos } =
codeBlock ??
(selection instanceof NodeSelection
? { node: selection.node, pos: selection.from }
: { node: selection.$from.node(), pos: selection.$from.before() });
const frequentLanguages = getFrequentCodeLanguages();
const frequentLangMenuItems = frequentLanguages.map((value) => {
const label = codeLanguages[value]?.label;
return langToMenuItem({ node, value, label });
});
const remainingLangMenuItems = Object.entries(codeLanguages)
.filter(
([value, item]) =>
!item.alias &&
!frequentLanguages.includes(value as keyof typeof codeLanguages)
)
.map(([value, item]) => langToMenuItem({ node, value, label: item.label }));
const getLanguageMenuItems = () =>
frequentLangMenuItems.length
? [
...frequentLangMenuItems,
{ name: "separator" },
...remainingLangMenuItems,
]
: remainingLangMenuItems;
const isEditingMermaid = !!(mermaidPluginKey.getState(state) as MermaidState)
?.editingId;
return [
{
name: "copyToClipboard",
icon: <CopyIcon />,
label: readOnly
? getLabelForLanguage(node.attrs.language ?? "none")
: undefined,
tooltip: t("Copy"),
attrs: { pos },
},
{
name: "separator",
},
{
name: "edit_mermaid",
icon: <EditIcon />,
tooltip: t("Edit diagram"),
shortcut: `${metaDisplay} Enter`,
visible: isMermaid(node) && !isEditingMermaid && !readOnly,
},
{
name: "separator",
},
{
name: "toggleCodeBlockWrap",
icon: <TextWrapIcon />,
tooltip: t("Wrap text"),
active: () => node.attrs.wrap,
visible: !readOnly && (!isMermaid(node) || isEditingMermaid),
},
{
name: "separator",
},
{
name: "code_block",
label: getLabelForLanguage(node.attrs.language ?? "none"),
icon: <ExpandedIcon />,
children: getLanguageMenuItems(),
visible: !readOnly,
},
];
}
const langToMenuItem = ({
node,
value,
label,
}: {
node: ProseMirrorNode;
value: string;
label: string;
}): MenuItem => ({
name: "code_block",
label,
active: () => (node.attrs.language ?? "none") === value,
attrs: {
language: value,
},
});