PageItemControl.tsx 12 KB

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