TemplateModal.tsx 11 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335
  1. import React, {
  2. useCallback, useEffect, useState, useMemo, type JSX,
  3. } from 'react';
  4. import assert from 'assert';
  5. import type { Lang } from '@growi/core';
  6. import { useTemplateModalStatus, useTemplateModalActions, type TemplateModalState } from '@growi/editor';
  7. import {
  8. extractSupportedLocales, getLocalizedTemplate, type TemplateSummary,
  9. } from '@growi/pluginkit/dist/v4';
  10. import { LoadingSpinner } from '@growi/ui/dist/components';
  11. import { useTranslation } from 'next-i18next';
  12. import {
  13. Modal,
  14. ModalHeader,
  15. ModalBody,
  16. ModalFooter,
  17. UncontrolledDropdown,
  18. DropdownToggle,
  19. DropdownMenu,
  20. DropdownItem,
  21. } from 'reactstrap';
  22. import { useSWRxTemplate, useSWRxTemplates } from '~/features/templates/stores';
  23. import { useSWRxPersonalSettings } from '~/stores/personal-settings';
  24. import { usePreviewOptions } from '~/stores/renderer';
  25. import loggerFactory from '~/utils/logger';
  26. import Preview from '../PageEditor/Preview';
  27. import { useFormatter } from './use-formatter';
  28. import styles from './TemplateModal.module.scss';
  29. const logger = loggerFactory('growi:components:TemplateModal');
  30. function constructTemplateId(templateSummary: TemplateSummary): string {
  31. const defaultTemplate = templateSummary.default;
  32. return `${defaultTemplate.pluginId ?? ''}_${defaultTemplate.id}`;
  33. }
  34. type TemplateSummaryItemProps = {
  35. templateSummary: TemplateSummary,
  36. selectedLocale?: string,
  37. onClick?: () => void,
  38. isSelected?: boolean,
  39. usersDefaultLang?: Lang,
  40. }
  41. const TemplateListGroupItem: React.FC<TemplateSummaryItemProps> = ({
  42. templateSummary,
  43. onClick,
  44. isSelected,
  45. usersDefaultLang,
  46. }) => {
  47. const localizedTemplate = getLocalizedTemplate(templateSummary, usersDefaultLang);
  48. const templateLocales = extractSupportedLocales(templateSummary);
  49. assert(localizedTemplate?.isValid);
  50. return (
  51. <a
  52. className={`list-group-item list-group-item-action ${isSelected ? 'active' : ''}`}
  53. onClick={onClick}
  54. >
  55. <h4 className="mb-1 d-flex">
  56. <span className="d-inline-block text-truncate">{localizedTemplate.title}</span>
  57. {localizedTemplate.pluginId != null ? <span className="material-symbols-outlined me-1 ms-2 text-muted small">extension</span> : ''}
  58. </h4>
  59. <p className="mb-2">{localizedTemplate.desc}</p>
  60. { templateLocales != null && Array.from(templateLocales).map(locale => (
  61. <span key={locale} className="badge border rounded-pill text-muted me-1">{locale}</span>
  62. ))}
  63. </a>
  64. );
  65. };
  66. const TemplateDropdownItem: React.FC<TemplateSummaryItemProps> = ({
  67. templateSummary,
  68. onClick,
  69. usersDefaultLang,
  70. }) => {
  71. const localizedTemplate = getLocalizedTemplate(templateSummary, usersDefaultLang);
  72. const templateLocales = extractSupportedLocales(templateSummary);
  73. assert(localizedTemplate?.isValid);
  74. return (
  75. <DropdownItem
  76. onClick={onClick}
  77. className="px-4 py-3"
  78. >
  79. <h4 className="mb-1 d-flex">
  80. <span className="d-inline-block text-truncate">{localizedTemplate.title}</span>
  81. {localizedTemplate.pluginId != null ? <span className="material-symbols-outlined me-1 ms-2 text-muted small">extension</span> : ''}
  82. </h4>
  83. <p className="mb-1 text-wrap">{localizedTemplate.desc}</p>
  84. { templateLocales != null && Array.from(templateLocales).map(locale => (
  85. <span key={locale} className="badge border rounded-pill text-muted me-1">{locale}</span>
  86. ))}
  87. </DropdownItem>
  88. );
  89. };
  90. type TemplateModalSubstanceProps = {
  91. templateModalStatus: TemplateModalState,
  92. close: () => void,
  93. }
  94. const TemplateModalSubstance = (props: TemplateModalSubstanceProps): JSX.Element => {
  95. const { templateModalStatus, close } = props;
  96. const { t } = useTranslation(['translation', 'commons']);
  97. const { data: personalSettingsInfo } = useSWRxPersonalSettings();
  98. const { data: rendererOptions } = usePreviewOptions();
  99. const { data: templateSummaries, isLoading } = useSWRxTemplates();
  100. const [selectedTemplateSummary, setSelectedTemplateSummary] = useState<TemplateSummary>();
  101. const [selectedTemplateLocale, setSelectedTemplateLocale] = useState<string>();
  102. const { data: selectedTemplateMarkdown } = useSWRxTemplate(selectedTemplateSummary, selectedTemplateLocale);
  103. const { format } = useFormatter();
  104. const usersDefaultLang = personalSettingsInfo?.lang;
  105. // Memoize heavy calculations
  106. const selectedLocalizedTemplate = useMemo(() => (
  107. getLocalizedTemplate(selectedTemplateSummary, usersDefaultLang)
  108. ), [selectedTemplateSummary, usersDefaultLang]);
  109. const selectedTemplateLocales = useMemo(() => (
  110. extractSupportedLocales(selectedTemplateSummary)
  111. ), [selectedTemplateSummary]);
  112. const submitHandler = useCallback((markdown?: string) => {
  113. if (markdown == null) {
  114. return;
  115. }
  116. if (templateModalStatus.onSubmit == null) {
  117. close();
  118. return;
  119. }
  120. templateModalStatus.onSubmit(format(selectedTemplateMarkdown));
  121. close();
  122. }, [close, format, selectedTemplateMarkdown, templateModalStatus]);
  123. const onClickHandler = useCallback((
  124. templateSummary: TemplateSummary,
  125. ) => {
  126. let localeToSet: string | Lang | undefined;
  127. if (selectedTemplateLocale != null && selectedTemplateLocale in templateSummary) {
  128. localeToSet = selectedTemplateLocale;
  129. }
  130. else if (usersDefaultLang != null && usersDefaultLang in templateSummary) {
  131. localeToSet = usersDefaultLang;
  132. }
  133. else {
  134. localeToSet = undefined;
  135. }
  136. setSelectedTemplateLocale(localeToSet);
  137. setSelectedTemplateSummary(templateSummary);
  138. }, [selectedTemplateLocale, usersDefaultLang]);
  139. // Memoize handler creator to avoid recreating onClick functions in map
  140. const createOnClickHandler = useCallback((templateSummary: TemplateSummary) => () => {
  141. onClickHandler(templateSummary);
  142. }, [onClickHandler]);
  143. // Memoize locale handler creator
  144. const createLocaleHandler = useCallback((locale: string) => () => {
  145. setSelectedTemplateLocale(locale);
  146. }, []);
  147. useEffect(() => {
  148. if (!templateModalStatus.isOpened) {
  149. setSelectedTemplateSummary(undefined);
  150. setSelectedTemplateLocale(undefined);
  151. }
  152. }, [templateModalStatus.isOpened]);
  153. return (
  154. <div data-testid="template-modal">
  155. <ModalHeader tag="h4" toggle={close}>
  156. {t('template.modal_label.Select template')}
  157. </ModalHeader>
  158. <ModalBody className="container">
  159. <div className="row">
  160. {/* List Group */}
  161. <div className="d-none d-lg-block col-lg-4">
  162. { isLoading && (
  163. <div className="h-100 d-flex justify-content-center align-items-center">
  164. <LoadingSpinner className="mx-auto text-muted fs-3" />
  165. </div>
  166. ) }
  167. <div className="list-group">
  168. { templateSummaries != null && templateSummaries.map((templateSummary) => {
  169. const templateId = constructTemplateId(templateSummary);
  170. const isSelected = selectedTemplateSummary != null && constructTemplateId(selectedTemplateSummary) === templateId;
  171. return (
  172. <TemplateListGroupItem
  173. key={templateId}
  174. templateSummary={templateSummary}
  175. onClick={createOnClickHandler(templateSummary)}
  176. isSelected={isSelected}
  177. usersDefaultLang={usersDefaultLang}
  178. />
  179. );
  180. }) }
  181. </div>
  182. </div>
  183. {/* Dropdown */}
  184. <div className="d-lg-none col mb-3">
  185. <UncontrolledDropdown>
  186. <DropdownToggle caret type="button" outline className="w-100 text-end" disabled={isLoading}>
  187. <span className="float-start">
  188. { (() => {
  189. if (isLoading) {
  190. return 'Loading..';
  191. }
  192. return selectedLocalizedTemplate != null && selectedLocalizedTemplate.isValid
  193. ? selectedLocalizedTemplate.title
  194. : t('Select template');
  195. })() }
  196. </span>
  197. </DropdownToggle>
  198. <DropdownMenu role="menu" className={`p-0 mw-100 ${styles['dm-templates']}`}>
  199. { templateSummaries != null && templateSummaries.map((templateSummary) => {
  200. const templateId = constructTemplateId(templateSummary);
  201. return (
  202. <TemplateDropdownItem
  203. key={templateId}
  204. templateSummary={templateSummary}
  205. onClick={createOnClickHandler(templateSummary)}
  206. usersDefaultLang={usersDefaultLang}
  207. />
  208. );
  209. }) }
  210. </DropdownMenu>
  211. </UncontrolledDropdown>
  212. </div>
  213. <div className="col-12 col-lg-8">
  214. <div className="row mb-2 mb-lg-0">
  215. <div className="col-6">
  216. <h3>{t('preview')}</h3>
  217. </div>
  218. <div className="col-6 d-flex justify-content-end">
  219. <UncontrolledDropdown>
  220. <DropdownToggle
  221. caret
  222. type="button"
  223. outline
  224. className="float-end"
  225. disabled={selectedTemplateSummary == null}
  226. data-testid="select-locale-dropdown-toggle"
  227. >
  228. <span className="float-start">{selectedTemplateLocale != null ? selectedTemplateLocale : t('Language')}</span>
  229. </DropdownToggle>
  230. <DropdownMenu className="dropdown-menu" role="menu">
  231. { selectedTemplateLocales != null && Array.from(selectedTemplateLocales).map((locale) => {
  232. return (
  233. <DropdownItem
  234. data-testid="select-locale-dropdown-item"
  235. key={locale}
  236. onClick={createLocaleHandler(locale)}
  237. >
  238. <span>{locale}</span>
  239. </DropdownItem>
  240. );
  241. }) }
  242. </DropdownMenu>
  243. </UncontrolledDropdown>
  244. </div>
  245. </div>
  246. <div className="card">
  247. <div className="card-body" style={{ height: '400px', overflowY: 'auto' }}>
  248. { rendererOptions != null && selectedTemplateSummary != null && (
  249. <Preview rendererOptions={rendererOptions} markdown={format(selectedTemplateMarkdown)} />
  250. ) }
  251. </div>
  252. </div>
  253. </div>
  254. </div>
  255. </ModalBody>
  256. <ModalFooter>
  257. <button type="button" className="btn btn-outline-secondary mx-1" onClick={close}>
  258. {t('Cancel')}
  259. </button>
  260. <button
  261. type="submit"
  262. className="btn btn-primary mx-1"
  263. onClick={() => submitHandler(selectedTemplateMarkdown)}
  264. disabled={selectedTemplateSummary == null}
  265. >
  266. {t('commons:Insert')}
  267. </button>
  268. </ModalFooter>
  269. </div>
  270. );
  271. };
  272. export const TemplateModal = (): JSX.Element => {
  273. const templateModalStatus = useTemplateModalStatus();
  274. const { close } = useTemplateModalActions();
  275. if (templateModalStatus == null) {
  276. return <></>;
  277. }
  278. return (
  279. <Modal className="link-edit-modal" isOpen={templateModalStatus.isOpened} toggle={close} size="xl" autoFocus={false}>
  280. { templateModalStatus.isOpened && (
  281. <TemplateModalSubstance templateModalStatus={templateModalStatus} close={close} />
  282. ) }
  283. </Modal>
  284. );
  285. };