PageItemControl.tsx 13 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381
  1. import React, {
  2. useState, useCallback, useEffect,
  3. } from 'react';
  4. import {
  5. type IPageInfoAll, isIPageInfoForOperation,
  6. } from '@growi/core/dist/interfaces';
  7. import { LoadingSpinner } from '@growi/ui/dist/components';
  8. import { useTranslation } from 'next-i18next';
  9. import {
  10. Dropdown, DropdownMenu, DropdownToggle, DropdownItem,
  11. } from 'reactstrap';
  12. import { NotAvailableForGuest } from '~/client/components/NotAvailableForGuest';
  13. import type { IPageOperationProcessData } from '~/interfaces/page-operation';
  14. import { useSWRxPageInfo } from '~/stores/page';
  15. import loggerFactory from '~/utils/logger';
  16. import { shouldRecoverPagePaths } from '~/utils/page-operation';
  17. const logger = loggerFactory('growi:cli:PageItemControl');
  18. export const MenuItemType = {
  19. BOOKMARK: 'bookmark',
  20. RENAME: 'rename',
  21. DUPLICATE: 'duplicate',
  22. DELETE: 'delete',
  23. REVERT: 'revert',
  24. PATH_RECOVERY: 'pathRecovery',
  25. SWITCH_CONTENT_WIDTH: 'switch_content_width',
  26. } as const;
  27. export type MenuItemType = typeof MenuItemType[keyof typeof MenuItemType];
  28. export type ForceHideMenuItems = MenuItemType[];
  29. export type AdditionalMenuItemsRendererProps = { pageInfo: IPageInfoAll };
  30. type CommonProps = {
  31. pageInfo?: IPageInfoAll,
  32. isEnableActions?: boolean,
  33. isReadOnlyUser?: boolean,
  34. forceHideMenuItems?: ForceHideMenuItems,
  35. onClickBookmarkMenuItem?: (pageId: string, newValue?: boolean) => Promise<void>,
  36. onClickRenameMenuItem?: (pageId: string, pageInfo: IPageInfoAll | undefined) => Promise<void> | void,
  37. onClickDuplicateMenuItem?: (pageId: string) => Promise<void> | void,
  38. onClickDeleteMenuItem?: (pageId: string, pageInfo: IPageInfoAll | undefined) => Promise<void> | void,
  39. onClickRevertMenuItem?: (pageId: string) => Promise<void> | void,
  40. onClickPathRecoveryMenuItem?: (pageId: string) => Promise<void> | void,
  41. additionalMenuItemOnTopRenderer?: React.FunctionComponent<AdditionalMenuItemsRendererProps>,
  42. additionalMenuItemRenderer?: React.FunctionComponent<AdditionalMenuItemsRendererProps>,
  43. isInstantRename?: boolean,
  44. alignEnd?: boolean,
  45. }
  46. type DropdownMenuProps = CommonProps & {
  47. pageId: string,
  48. isLoading?: boolean,
  49. operationProcessData?: IPageOperationProcessData,
  50. }
  51. const PageItemControlDropdownMenu = React.memo((props: DropdownMenuProps): JSX.Element => {
  52. const { t } = useTranslation('');
  53. const {
  54. pageId, isLoading, pageInfo, isEnableActions, isReadOnlyUser, forceHideMenuItems, operationProcessData,
  55. onClickBookmarkMenuItem, onClickRenameMenuItem, onClickDuplicateMenuItem, onClickDeleteMenuItem,
  56. onClickRevertMenuItem, onClickPathRecoveryMenuItem,
  57. additionalMenuItemOnTopRenderer: AdditionalMenuItemsOnTop,
  58. additionalMenuItemRenderer: AdditionalMenuItems,
  59. isInstantRename, alignEnd,
  60. } = props;
  61. // eslint-disable-next-line react-hooks/rules-of-hooks
  62. const bookmarkItemClickedHandler = useCallback(async() => {
  63. if (!isIPageInfoForOperation(pageInfo) || onClickBookmarkMenuItem == null) {
  64. return;
  65. }
  66. await onClickBookmarkMenuItem(pageId, !pageInfo.isBookmarked);
  67. }, [onClickBookmarkMenuItem, pageId, pageInfo]);
  68. // eslint-disable-next-line react-hooks/rules-of-hooks
  69. const renameItemClickedHandler = useCallback(async() => {
  70. if (onClickRenameMenuItem == null) {
  71. return;
  72. }
  73. if (!pageInfo?.isMovable) {
  74. logger.warn('This page could not be renamed.');
  75. return;
  76. }
  77. await onClickRenameMenuItem(pageId, pageInfo);
  78. }, [onClickRenameMenuItem, pageId, pageInfo]);
  79. // eslint-disable-next-line react-hooks/rules-of-hooks
  80. const duplicateItemClickedHandler = useCallback(async() => {
  81. if (onClickDuplicateMenuItem == null) {
  82. return;
  83. }
  84. await onClickDuplicateMenuItem(pageId);
  85. }, [onClickDuplicateMenuItem, pageId]);
  86. const revertItemClickedHandler = useCallback(async() => {
  87. if (onClickRevertMenuItem == null) {
  88. return;
  89. }
  90. await onClickRevertMenuItem(pageId);
  91. }, [onClickRevertMenuItem, pageId]);
  92. // eslint-disable-next-line react-hooks/rules-of-hooks
  93. const deleteItemClickedHandler = useCallback(async() => {
  94. if (pageInfo == null || onClickDeleteMenuItem == null) {
  95. return;
  96. }
  97. if (!pageInfo.isDeletable) {
  98. logger.warn('This page could not be deleted.');
  99. return;
  100. }
  101. await onClickDeleteMenuItem(pageId, pageInfo);
  102. }, [onClickDeleteMenuItem, pageId, pageInfo]);
  103. // eslint-disable-next-line react-hooks/rules-of-hooks
  104. const pathRecoveryItemClickedHandler = useCallback(async() => {
  105. if (onClickPathRecoveryMenuItem == null) {
  106. return;
  107. }
  108. await onClickPathRecoveryMenuItem(pageId);
  109. }, [onClickPathRecoveryMenuItem, pageId]);
  110. let contents = <></>;
  111. if (isLoading) {
  112. contents = (
  113. <div className="text-muted text-center my-2">
  114. <LoadingSpinner />
  115. </div>
  116. );
  117. }
  118. else if (pageId != null && pageInfo != null) {
  119. const showDeviderBeforeAdditionalMenuItems = (forceHideMenuItems?.length ?? 0) < 3;
  120. const showDeviderBeforeDelete = AdditionalMenuItems != null || showDeviderBeforeAdditionalMenuItems;
  121. // PathRecovery
  122. // Todo: It is wanted to find a better way to pass operationProcessData to PageItemControl
  123. const shouldShowPathRecoveryButton = operationProcessData != null ? shouldRecoverPagePaths(operationProcessData) : false;
  124. contents = (
  125. <>
  126. { !isEnableActions && (
  127. <DropdownItem>
  128. <p>
  129. {t('search_result.currently_not_implemented')}
  130. </p>
  131. </DropdownItem>
  132. ) }
  133. { AdditionalMenuItemsOnTop && (
  134. <>
  135. <AdditionalMenuItemsOnTop pageInfo={pageInfo} />
  136. <DropdownItem divider />
  137. </>
  138. ) }
  139. {/* Bookmark */}
  140. { !forceHideMenuItems?.includes(MenuItemType.BOOKMARK) && isEnableActions && isIPageInfoForOperation(pageInfo) && (
  141. <DropdownItem
  142. onClick={bookmarkItemClickedHandler}
  143. className="grw-page-control-dropdown-item"
  144. data-testid={pageInfo.isBookmarked ? 'remove-bookmark-btn' : 'add-bookmark-btn'}
  145. >
  146. <span className="material-symbols-outlined grw-page-control-dropdown-icon">bookmark</span>
  147. { pageInfo.isBookmarked ? t('remove_bookmark') : t('add_bookmark') }
  148. </DropdownItem>
  149. ) }
  150. {/* Move/Rename */}
  151. { !forceHideMenuItems?.includes(MenuItemType.RENAME) && isEnableActions && !isReadOnlyUser && pageInfo.isMovable && (
  152. <DropdownItem
  153. onClick={renameItemClickedHandler}
  154. data-testid="rename-page-btn"
  155. className="grw-page-control-dropdown-item"
  156. >
  157. <span className="material-symbols-outlined me-1 grw-page-control-dropdown-icon">redo</span>
  158. {t(isInstantRename ? 'Rename' : 'Move/Rename')}
  159. </DropdownItem>
  160. ) }
  161. {/* Duplicate */}
  162. { !forceHideMenuItems?.includes(MenuItemType.DUPLICATE) && isEnableActions && !isReadOnlyUser && (
  163. <DropdownItem
  164. onClick={duplicateItemClickedHandler}
  165. data-testid="open-page-duplicate-modal-btn"
  166. className="grw-page-control-dropdown-item"
  167. >
  168. <span className="material-symbols-outlined me-1 grw-page-control-dropdown-icon">file_copy</span>
  169. {t('Duplicate')}
  170. </DropdownItem>
  171. ) }
  172. {/* Revert */}
  173. { !forceHideMenuItems?.includes(MenuItemType.REVERT) && isEnableActions && !isReadOnlyUser && pageInfo.isRevertible && (
  174. <DropdownItem
  175. onClick={revertItemClickedHandler}
  176. className="grw-page-control-dropdown-item"
  177. >
  178. <span className="material-symbols-outlined me-1 grw-page-control-dropdown-icon">undo</span>
  179. {t('modal_putback.label.Put Back Page')}
  180. </DropdownItem>
  181. ) }
  182. { AdditionalMenuItems && (
  183. <>
  184. { showDeviderBeforeAdditionalMenuItems && <DropdownItem divider /> }
  185. <AdditionalMenuItems pageInfo={pageInfo} />
  186. </>
  187. ) }
  188. {/* PathRecovery */}
  189. { !forceHideMenuItems?.includes(MenuItemType.PATH_RECOVERY) && isEnableActions && !isReadOnlyUser && shouldShowPathRecoveryButton && (
  190. <DropdownItem
  191. onClick={pathRecoveryItemClickedHandler}
  192. className="grw-page-control-dropdown-item"
  193. >
  194. <span className="material-symbols-outlined me-1 grw-page-control-dropdown-icon">build</span>
  195. {t('PathRecovery')}
  196. </DropdownItem>
  197. ) }
  198. {/* divider */}
  199. {/* Delete */}
  200. { !forceHideMenuItems?.includes(MenuItemType.DELETE) && isEnableActions && !isReadOnlyUser && pageInfo.isDeletable && (
  201. <>
  202. { showDeviderBeforeDelete && <DropdownItem divider /> }
  203. <DropdownItem
  204. className={`pt-2 grw-page-control-dropdown-item ${pageInfo.isDeletable ? 'text-danger' : ''}`}
  205. disabled={!pageInfo.isDeletable}
  206. onClick={deleteItemClickedHandler}
  207. data-testid="open-page-delete-modal-btn"
  208. >
  209. <span className="material-symbols-outlined me-1 grw-page-control-dropdown-icon">delete</span>
  210. {t('Delete')}
  211. </DropdownItem>
  212. </>
  213. )}
  214. </>
  215. );
  216. }
  217. return (
  218. <DropdownMenu
  219. className="d-print-none"
  220. data-testid="page-item-control-menu"
  221. end={alignEnd}
  222. container="body"
  223. persist={!!alignEnd}
  224. style={{ zIndex: 1055 }} /* make it larger than $zindex-modal of bootstrap */
  225. >
  226. {contents}
  227. </DropdownMenu>
  228. );
  229. });
  230. PageItemControlDropdownMenu.displayName = 'PageItemControl';
  231. type PageItemControlSubstanceProps = CommonProps & {
  232. pageId: string,
  233. children?: React.ReactNode,
  234. operationProcessData?: IPageOperationProcessData,
  235. }
  236. export const PageItemControlSubstance = (props: PageItemControlSubstanceProps): JSX.Element => {
  237. const {
  238. pageId, pageInfo: presetPageInfo, children, onClickBookmarkMenuItem, onClickRenameMenuItem,
  239. onClickDuplicateMenuItem, onClickDeleteMenuItem, onClickPathRecoveryMenuItem,
  240. } = props;
  241. const [isOpen, setIsOpen] = useState(false);
  242. const [shouldFetch, setShouldFetch] = useState(false);
  243. const { data: fetchedPageInfo, mutate: mutatePageInfo } = useSWRxPageInfo(shouldFetch ? pageId : null);
  244. // update shouldFetch (and will never be false)
  245. useEffect(() => {
  246. if (shouldFetch) {
  247. return;
  248. }
  249. if (!isIPageInfoForOperation(presetPageInfo) && isOpen) {
  250. setShouldFetch(true);
  251. }
  252. }, [isOpen, presetPageInfo, shouldFetch]);
  253. // mutate after handle event
  254. const bookmarkMenuItemClickHandler = useCallback(async(_pageId: string, _newValue: boolean) => {
  255. if (onClickBookmarkMenuItem != null) {
  256. await onClickBookmarkMenuItem(_pageId, _newValue);
  257. }
  258. if (shouldFetch) {
  259. mutatePageInfo();
  260. }
  261. }, [mutatePageInfo, onClickBookmarkMenuItem, shouldFetch]);
  262. const isLoading = shouldFetch && fetchedPageInfo == null;
  263. const renameMenuItemClickHandler = useCallback(async() => {
  264. if (onClickRenameMenuItem == null) {
  265. return;
  266. }
  267. await onClickRenameMenuItem(pageId, fetchedPageInfo ?? presetPageInfo);
  268. }, [onClickRenameMenuItem, pageId, fetchedPageInfo, presetPageInfo]);
  269. const duplicateMenuItemClickHandler = useCallback(async() => {
  270. if (onClickDuplicateMenuItem == null) {
  271. return;
  272. }
  273. await onClickDuplicateMenuItem(pageId);
  274. }, [onClickDuplicateMenuItem, pageId]);
  275. const deleteMenuItemClickHandler = useCallback(async() => {
  276. if (onClickDeleteMenuItem == null) {
  277. return;
  278. }
  279. await onClickDeleteMenuItem(pageId, fetchedPageInfo ?? presetPageInfo);
  280. }, [onClickDeleteMenuItem, pageId, fetchedPageInfo, presetPageInfo]);
  281. const pathRecoveryMenuItemClickHandler = useCallback(async() => {
  282. if (onClickPathRecoveryMenuItem == null) {
  283. return;
  284. }
  285. await onClickPathRecoveryMenuItem(pageId);
  286. }, [onClickPathRecoveryMenuItem, pageId]);
  287. return (
  288. <NotAvailableForGuest>
  289. <Dropdown isOpen={isOpen} toggle={() => setIsOpen(!isOpen)} className="grw-page-item-control" data-testid="open-page-item-control-btn">
  290. { children ?? (
  291. <DropdownToggle role="button" color="transparent" className="border-0 rounded btn-page-item-control d-flex align-items-center justify-content-center">
  292. <span className="material-symbols-outlined">more_vert</span>
  293. </DropdownToggle>
  294. ) }
  295. { isOpen && (
  296. <PageItemControlDropdownMenu
  297. {...props}
  298. isLoading={isLoading}
  299. pageInfo={fetchedPageInfo ?? presetPageInfo}
  300. onClickBookmarkMenuItem={bookmarkMenuItemClickHandler}
  301. onClickRenameMenuItem={renameMenuItemClickHandler}
  302. onClickDuplicateMenuItem={duplicateMenuItemClickHandler}
  303. onClickDeleteMenuItem={deleteMenuItemClickHandler}
  304. onClickPathRecoveryMenuItem={pathRecoveryMenuItemClickHandler}
  305. />
  306. ) }
  307. </Dropdown>
  308. </NotAvailableForGuest>
  309. );
  310. };
  311. export type PageItemControlProps = CommonProps & {
  312. pageId?: string,
  313. children?: React.ReactNode,
  314. operationProcessData?: IPageOperationProcessData,
  315. }
  316. export const PageItemControl = (props: PageItemControlProps): JSX.Element => {
  317. const { pageId } = props;
  318. if (pageId == null) {
  319. return <></>;
  320. }
  321. return <PageItemControlSubstance pageId={pageId} {...props} />;
  322. };