mirror of
https://github.com/outline/outline.git
synced 2026-11-21 13:34:02 +03:00
* Convert insights from sidebar to modal dialog - Remove insights routing and sidebar layout - Update DocumentMeta to use modal action instead of navigation - Convert Insights component to modal-ready format - Clean up route helpers and authenticated layout - Remove insights route from authenticated routes Co-authored-by: Tom Moor <tom@getoutline.com> * Applied automatic fixes * refactor * singular * refactor --------- Co-authored-by: codegen-sh[bot] <131295404+codegen-sh[bot]@users.noreply.github.com> Co-authored-by: Tom Moor <tom@getoutline.com>
332 lines
8.6 KiB
TypeScript
332 lines
8.6 KiB
TypeScript
import noop from "lodash/noop";
|
|
import { observer } from "mobx-react";
|
|
import { InputIcon, SearchIcon } from "outline-icons";
|
|
import * as React from "react";
|
|
import { useTranslation } from "react-i18next";
|
|
import styled from "styled-components";
|
|
import breakpoint from "styled-components-breakpoint";
|
|
import { s } from "@shared/styles";
|
|
import { SubscriptionType, UserPreference } from "@shared/types";
|
|
import Document from "~/models/Document";
|
|
import { DropdownMenu } from "~/components/Menu/DropdownMenu";
|
|
import { OverflowMenuButton } from "~/components/Menu/OverflowMenuButton";
|
|
import Switch from "~/components/Switch";
|
|
import { ActionV2Separator, createActionV2 } from "~/actions";
|
|
import {
|
|
pinDocument,
|
|
createTemplateFromDocument,
|
|
subscribeDocument,
|
|
unsubscribeDocument,
|
|
moveDocument,
|
|
deleteDocument,
|
|
permanentlyDeleteDocument,
|
|
downloadDocument,
|
|
importDocument,
|
|
starDocument,
|
|
unstarDocument,
|
|
duplicateDocument,
|
|
archiveDocument,
|
|
openDocumentHistory,
|
|
openDocumentInsights,
|
|
publishDocument,
|
|
unpublishDocument,
|
|
printDocument,
|
|
openDocumentComments,
|
|
createDocumentFromTemplate,
|
|
createNestedDocument,
|
|
shareDocument,
|
|
copyDocument,
|
|
searchInDocument,
|
|
leaveDocument,
|
|
moveTemplate,
|
|
restoreDocument,
|
|
restoreDocumentToCollection,
|
|
editDocument,
|
|
applyTemplateFactory,
|
|
} from "~/actions/definitions/documents";
|
|
import useActionContext from "~/hooks/useActionContext";
|
|
import useCurrentUser from "~/hooks/useCurrentUser";
|
|
import useMobile from "~/hooks/useMobile";
|
|
import usePolicy from "~/hooks/usePolicy";
|
|
import useRequest from "~/hooks/useRequest";
|
|
import useStores from "~/hooks/useStores";
|
|
import { ActiveDocumentSection } from "~/actions/sections";
|
|
import { useTemplateMenuActions } from "~/hooks/useTemplateMenuActions";
|
|
import { useMenuAction } from "~/hooks/useMenuAction";
|
|
import { MenuSeparator } from "~/components/primitives/components/Menu";
|
|
|
|
type Props = {
|
|
/** Document for which the menu is to be shown */
|
|
document: Document;
|
|
/** Alignment w.r.t trigger - defaults to start */
|
|
align?: "start" | "end";
|
|
/** Trigger's variant - renders nude variant if unset */
|
|
neutral?: boolean;
|
|
/** Pass true if the document is currently being displayed */
|
|
showDisplayOptions?: boolean;
|
|
/** Whether to include the option of toggling embeds as menu item */
|
|
showToggleEmbeds?: boolean;
|
|
/** Invoked when the "Find and replace" menu item is clicked */
|
|
onFindAndReplace?: () => void;
|
|
/** Callback when a template is selected to apply its content to the document */
|
|
onSelectTemplate?: (template: Document) => void;
|
|
/** Invoked when the "Rename" menu item is clicked */
|
|
onRename?: () => void;
|
|
/** Invoked when menu is opened */
|
|
onOpen?: () => void;
|
|
/** Invoked when menu is closed */
|
|
onClose?: () => void;
|
|
};
|
|
|
|
function DocumentMenu({
|
|
document,
|
|
align,
|
|
neutral,
|
|
showToggleEmbeds,
|
|
showDisplayOptions,
|
|
onSelectTemplate,
|
|
onRename,
|
|
onOpen,
|
|
onClose,
|
|
onFindAndReplace,
|
|
}: Props) {
|
|
const { t } = useTranslation();
|
|
const user = useCurrentUser();
|
|
const isMobile = useMobile();
|
|
const can = usePolicy(document);
|
|
|
|
const { subscriptions, pins } = useStores();
|
|
|
|
const {
|
|
loading: auxDataLoading,
|
|
loaded: auxDataLoaded,
|
|
request: auxDataRequest,
|
|
} = useRequest(() =>
|
|
Promise.all([
|
|
subscriptions.fetchOne({
|
|
documentId: document.id,
|
|
event: SubscriptionType.Document,
|
|
}),
|
|
document.collectionId
|
|
? subscriptions.fetchOne({
|
|
collectionId: document.collectionId,
|
|
event: SubscriptionType.Document,
|
|
})
|
|
: noop,
|
|
pins.fetchOne({
|
|
documentId: document.id,
|
|
collectionId: document.collectionId ?? null,
|
|
}),
|
|
])
|
|
);
|
|
|
|
const handlePointerEnter = React.useCallback(() => {
|
|
if (!auxDataLoading && !auxDataLoaded) {
|
|
void auxDataRequest();
|
|
void document.loadRelations();
|
|
}
|
|
}, [auxDataLoading, auxDataLoaded, auxDataRequest, document]);
|
|
|
|
const handleEmbedsToggle = React.useCallback(
|
|
(checked: boolean) => {
|
|
if (checked) {
|
|
document.enableEmbeds();
|
|
} else {
|
|
document.disableEmbeds();
|
|
}
|
|
},
|
|
[document]
|
|
);
|
|
|
|
const handleFullWidthToggle = React.useCallback(
|
|
(checked: boolean) => {
|
|
user.setPreference(UserPreference.FullWidthDocuments, checked);
|
|
void user.save();
|
|
document.fullWidth = checked;
|
|
void document.save({ fullWidth: checked });
|
|
},
|
|
[user, document]
|
|
);
|
|
|
|
const handleInsightsToggle = React.useCallback(
|
|
(checked: boolean) => {
|
|
void document.save({ insightsEnabled: checked });
|
|
},
|
|
[document]
|
|
);
|
|
|
|
const templateMenuActions = useTemplateMenuActions({
|
|
document,
|
|
onSelectTemplate,
|
|
});
|
|
|
|
const actions = React.useMemo(
|
|
() => [
|
|
restoreDocument,
|
|
restoreDocumentToCollection,
|
|
starDocument,
|
|
unstarDocument,
|
|
subscribeDocument,
|
|
unsubscribeDocument,
|
|
createActionV2({
|
|
name: `${t("Find and replace")}…`,
|
|
section: ActiveDocumentSection,
|
|
icon: <SearchIcon />,
|
|
visible: !!onFindAndReplace && isMobile,
|
|
perform: () => onFindAndReplace?.(),
|
|
}),
|
|
ActionV2Separator,
|
|
editDocument,
|
|
createActionV2({
|
|
name: `${t("Rename")}…`,
|
|
section: ActiveDocumentSection,
|
|
icon: <InputIcon />,
|
|
visible: !!can.update && !user.separateEditMode && !!onRename,
|
|
perform: () => requestAnimationFrame(() => onRename?.()),
|
|
}),
|
|
shareDocument,
|
|
createNestedDocument,
|
|
importDocument,
|
|
createTemplateFromDocument,
|
|
duplicateDocument,
|
|
publishDocument,
|
|
unpublishDocument,
|
|
archiveDocument,
|
|
moveDocument,
|
|
moveTemplate,
|
|
applyTemplateFactory({ actions: templateMenuActions }),
|
|
pinDocument,
|
|
createDocumentFromTemplate,
|
|
ActionV2Separator,
|
|
openDocumentComments,
|
|
openDocumentHistory,
|
|
openDocumentInsights,
|
|
downloadDocument,
|
|
copyDocument,
|
|
printDocument,
|
|
searchInDocument,
|
|
ActionV2Separator,
|
|
deleteDocument,
|
|
permanentlyDeleteDocument,
|
|
leaveDocument,
|
|
],
|
|
[
|
|
t,
|
|
isMobile,
|
|
templateMenuActions,
|
|
can.update,
|
|
user.separateEditMode,
|
|
onFindAndReplace,
|
|
onRename,
|
|
]
|
|
);
|
|
|
|
const rootAction = useMenuAction(actions);
|
|
|
|
const context = useActionContext({
|
|
isContextMenu: true,
|
|
activeDocumentId: document.id,
|
|
activeCollectionId: document.collectionId ?? undefined,
|
|
});
|
|
|
|
const toggleSwitches = React.useMemo<React.ReactNode>(() => {
|
|
if (!can.update || !(showDisplayOptions || showToggleEmbeds)) {
|
|
return;
|
|
}
|
|
|
|
return (
|
|
<>
|
|
<MenuSeparator />
|
|
<DisplayOptions>
|
|
{can.updateInsights && (
|
|
<Style>
|
|
<ToggleMenuItem
|
|
width={26}
|
|
height={14}
|
|
label={t("Enable viewer insights")}
|
|
labelPosition="left"
|
|
checked={document.insightsEnabled}
|
|
onChange={handleInsightsToggle}
|
|
/>
|
|
</Style>
|
|
)}
|
|
{showToggleEmbeds && (
|
|
<Style>
|
|
<ToggleMenuItem
|
|
width={26}
|
|
height={14}
|
|
label={t("Enable embeds")}
|
|
labelPosition="left"
|
|
checked={!document.embedsDisabled}
|
|
onChange={handleEmbedsToggle}
|
|
/>
|
|
</Style>
|
|
)}
|
|
{showDisplayOptions && !isMobile && (
|
|
<Style>
|
|
<ToggleMenuItem
|
|
width={26}
|
|
height={14}
|
|
label={t("Full width")}
|
|
labelPosition="left"
|
|
checked={document.fullWidth}
|
|
onChange={handleFullWidthToggle}
|
|
/>
|
|
</Style>
|
|
)}
|
|
</DisplayOptions>
|
|
</>
|
|
);
|
|
}, [
|
|
t,
|
|
can.update,
|
|
document.embedsDisabled,
|
|
document.fullWidth,
|
|
document.insightsEnabled,
|
|
isMobile,
|
|
showDisplayOptions,
|
|
showToggleEmbeds,
|
|
handleEmbedsToggle,
|
|
handleFullWidthToggle,
|
|
]);
|
|
|
|
return (
|
|
<DropdownMenu
|
|
action={rootAction}
|
|
context={context}
|
|
align={align}
|
|
onOpen={onOpen}
|
|
onClose={onClose}
|
|
ariaLabel={t("Document options")}
|
|
append={toggleSwitches}
|
|
>
|
|
<OverflowMenuButton
|
|
neutral={neutral}
|
|
onPointerEnter={handlePointerEnter}
|
|
/>
|
|
</DropdownMenu>
|
|
);
|
|
}
|
|
|
|
const ToggleMenuItem = styled(Switch)`
|
|
* {
|
|
font-weight: normal;
|
|
color: ${s("textSecondary")};
|
|
}
|
|
`;
|
|
|
|
const DisplayOptions = styled.div`
|
|
padding: 8px 0 0;
|
|
`;
|
|
|
|
const Style = styled.div`
|
|
padding: 12px;
|
|
|
|
${breakpoint("tablet")`
|
|
padding: 4px 12px;
|
|
font-size: 14px;
|
|
`};
|
|
`;
|
|
|
|
export default observer(DocumentMenu);
|