PageItemControl.tsx 12 KB

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