TemplateModal.tsx 11 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309
  1. import React, {
  2. useCallback, useEffect, useState,
  3. } from 'react';
  4. import assert from 'assert';
  5. import type { Lang } from '@growi/core';
  6. import { useTemplateModal, type TemplateModalStatus } from '@growi/editor/src/stores/use-template-modal';
  7. import {
  8. extractSupportedLocales, getLocalizedTemplate, type TemplateSummary,
  9. } from '@growi/pluginkit/dist/v4';
  10. import { useTranslation } from 'next-i18next';
  11. import {
  12. Modal,
  13. ModalHeader,
  14. ModalBody,
  15. ModalFooter,
  16. UncontrolledDropdown,
  17. DropdownToggle,
  18. DropdownMenu,
  19. DropdownItem,
  20. } from 'reactstrap';
  21. import { useSWRxTemplate, useSWRxTemplates } from '~/features/templates/stores';
  22. import { usePersonalSettings } from '~/stores/personal-settings';
  23. import { usePreviewOptions } from '~/stores/renderer';
  24. import loggerFactory from '~/utils/logger';
  25. import Preview from '../PageEditor/Preview';
  26. import { useFormatter } from './use-formatter';
  27. import styles from './TemplateModal.module.scss';
  28. const logger = loggerFactory('growi:components:TemplateModal');
  29. function constructTemplateId(templateSummary: TemplateSummary): string {
  30. const defaultTemplate = templateSummary.default;
  31. return `${defaultTemplate.pluginId ?? ''}_${defaultTemplate.id}`;
  32. }
  33. type TemplateSummaryItemProps = {
  34. templateSummary: TemplateSummary,
  35. selectedLocale?: string,
  36. onClick?: () => void,
  37. isSelected?: boolean,
  38. usersDefaultLang?: Lang,
  39. }
  40. const TemplateListGroupItem: React.FC<TemplateSummaryItemProps> = ({
  41. templateSummary,
  42. onClick,
  43. isSelected,
  44. usersDefaultLang,
  45. }) => {
  46. const localizedTemplate = getLocalizedTemplate(templateSummary, usersDefaultLang);
  47. const templateLocales = extractSupportedLocales(templateSummary);
  48. assert(localizedTemplate?.isValid);
  49. return (
  50. <a
  51. className={`list-group-item list-group-item-action ${isSelected ? 'active' : ''}`}
  52. onClick={onClick}
  53. aria-current="true"
  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: TemplateModalStatus,
  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 } = usePersonalSettings();
  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. const selectedLocalizedTemplate = getLocalizedTemplate(selectedTemplateSummary, usersDefaultLang);
  106. const selectedTemplateLocales = extractSupportedLocales(selectedTemplateSummary);
  107. const submitHandler = useCallback((markdown?: string) => {
  108. if (markdown == null) {
  109. return;
  110. }
  111. if (templateModalStatus.onSubmit == null) {
  112. close();
  113. return;
  114. }
  115. templateModalStatus.onSubmit(format(selectedTemplateMarkdown));
  116. close();
  117. }, [close, format, selectedTemplateMarkdown, templateModalStatus]);
  118. const onClickHandler = useCallback((
  119. templateSummary: TemplateSummary,
  120. ) => {
  121. let localeToSet: string | Lang | undefined;
  122. if (selectedTemplateLocale != null && selectedTemplateLocale in templateSummary) {
  123. localeToSet = selectedTemplateLocale;
  124. }
  125. else if (usersDefaultLang != null && usersDefaultLang in templateSummary) {
  126. localeToSet = usersDefaultLang;
  127. }
  128. else {
  129. localeToSet = undefined;
  130. }
  131. setSelectedTemplateLocale(localeToSet);
  132. setSelectedTemplateSummary(templateSummary);
  133. }, [selectedTemplateLocale, usersDefaultLang]);
  134. useEffect(() => {
  135. if (!templateModalStatus.isOpened) {
  136. setSelectedTemplateSummary(undefined);
  137. setSelectedTemplateLocale(undefined);
  138. }
  139. }, [templateModalStatus.isOpened]);
  140. return (
  141. <div data-testid="template-modal">
  142. <ModalHeader tag="h4" toggle={close} className="bg-primary text-light">
  143. {t('template.modal_label.Select template')}
  144. </ModalHeader>
  145. <ModalBody className="container">
  146. <div className="row">
  147. {/* List Group */}
  148. <div className="d-none d-lg-block col-lg-4">
  149. { isLoading && (
  150. <div className="h-100 d-flex justify-content-center align-items-center">
  151. <i className="fa fa-2x fa-spinner fa-pulse text-muted mx-auto"></i>
  152. </div>
  153. ) }
  154. <div className="list-group">
  155. { templateSummaries != null && templateSummaries.map((templateSummary) => {
  156. const templateId = constructTemplateId(templateSummary);
  157. const isSelected = selectedTemplateSummary != null && constructTemplateId(selectedTemplateSummary) === templateId;
  158. return (
  159. <TemplateListGroupItem
  160. key={templateId}
  161. templateSummary={templateSummary}
  162. onClick={() => onClickHandler(templateSummary)}
  163. isSelected={isSelected}
  164. usersDefaultLang={usersDefaultLang}
  165. />
  166. );
  167. }) }
  168. </div>
  169. </div>
  170. {/* Dropdown */}
  171. <div className="d-lg-none col mb-3">
  172. <UncontrolledDropdown>
  173. <DropdownToggle caret type="button" outline className="w-100 text-end" disabled={isLoading}>
  174. <span className="float-start">
  175. { (() => {
  176. if (isLoading) {
  177. return 'Loading..';
  178. }
  179. return selectedLocalizedTemplate != null && selectedLocalizedTemplate.isValid
  180. ? selectedLocalizedTemplate.title
  181. : t('Select template');
  182. })() }
  183. </span>
  184. </DropdownToggle>
  185. <DropdownMenu role="menu" className={`p-0 mw-100 ${styles['dm-templates']}`}>
  186. { templateSummaries != null && templateSummaries.map((templateSummary) => {
  187. const templateId = constructTemplateId(templateSummary);
  188. return (
  189. <TemplateDropdownItem
  190. key={templateId}
  191. templateSummary={templateSummary}
  192. onClick={() => onClickHandler(templateSummary)}
  193. usersDefaultLang={usersDefaultLang}
  194. />
  195. );
  196. }) }
  197. </DropdownMenu>
  198. </UncontrolledDropdown>
  199. </div>
  200. <div className="col-12 col-lg-8">
  201. <div className="row mb-2 mb-lg-0">
  202. <div className="col-6">
  203. <h3>{t('preview')}</h3>
  204. </div>
  205. <div className="col-6 d-flex justify-content-end">
  206. <UncontrolledDropdown>
  207. <DropdownToggle caret type="button" outline className="float-end" disabled={selectedTemplateSummary == null}>
  208. <span className="float-start">{selectedTemplateLocale != null ? selectedTemplateLocale : t('Language')}</span>
  209. </DropdownToggle>
  210. <DropdownMenu className="dropdown-menu" role="menu">
  211. { selectedTemplateLocales != null && Array.from(selectedTemplateLocales).map((locale) => {
  212. return (
  213. <DropdownItem
  214. key={locale}
  215. onClick={() => setSelectedTemplateLocale(locale)}
  216. >
  217. <span>{locale}</span>
  218. </DropdownItem>
  219. );
  220. }) }
  221. </DropdownMenu>
  222. </UncontrolledDropdown>
  223. </div>
  224. </div>
  225. <div className="card">
  226. <div className="card-body" style={{ height: '400px', overflowY: 'auto' }}>
  227. { rendererOptions != null && selectedTemplateSummary != null && (
  228. <Preview rendererOptions={rendererOptions} markdown={format(selectedTemplateMarkdown)} />
  229. ) }
  230. </div>
  231. </div>
  232. </div>
  233. </div>
  234. </ModalBody>
  235. <ModalFooter>
  236. <button type="button" className="btn btn-outline-secondary mx-1" onClick={close}>
  237. {t('Cancel')}
  238. </button>
  239. <button
  240. type="submit"
  241. className="btn btn-primary mx-1"
  242. onClick={() => submitHandler(selectedTemplateMarkdown)}
  243. disabled={selectedTemplateSummary == null}
  244. >
  245. {t('commons:Insert')}
  246. </button>
  247. </ModalFooter>
  248. </div>
  249. );
  250. };
  251. export const TemplateModal = (): JSX.Element => {
  252. const { data: templateModalStatus, close } = useTemplateModal();
  253. if (templateModalStatus == null) {
  254. return <></>;
  255. }
  256. return (
  257. <Modal className="link-edit-modal" isOpen={templateModalStatus.isOpened} toggle={close} size="xl" autoFocus={false}>
  258. { templateModalStatus.isOpened && (
  259. <TemplateModalSubstance templateModalStatus={templateModalStatus} close={close} />
  260. ) }
  261. </Modal>
  262. );
  263. };