TemplateModal.tsx 11 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310
  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/dist/client';
  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 { usePersonalSettings } 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. aria-current="true"
  55. >
  56. <h4 className="mb-1 d-flex">
  57. <span className="d-inline-block text-truncate">{localizedTemplate.title}</span>
  58. {localizedTemplate.pluginId != null ? <span className="material-symbols-outlined me-1 ms-2 text-muted small">extension</span> : ''}
  59. </h4>
  60. <p className="mb-2">{localizedTemplate.desc}</p>
  61. { templateLocales != null && Array.from(templateLocales).map(locale => (
  62. <span key={locale} className="badge border rounded-pill text-muted me-1">{locale}</span>
  63. ))}
  64. </a>
  65. );
  66. };
  67. const TemplateDropdownItem: React.FC<TemplateSummaryItemProps> = ({
  68. templateSummary,
  69. onClick,
  70. usersDefaultLang,
  71. }) => {
  72. const localizedTemplate = getLocalizedTemplate(templateSummary, usersDefaultLang);
  73. const templateLocales = extractSupportedLocales(templateSummary);
  74. assert(localizedTemplate?.isValid);
  75. return (
  76. <DropdownItem
  77. onClick={onClick}
  78. className="px-4 py-3"
  79. >
  80. <h4 className="mb-1 d-flex">
  81. <span className="d-inline-block text-truncate">{localizedTemplate.title}</span>
  82. {localizedTemplate.pluginId != null ? <span className="material-symbols-outlined me-1 ms-2 text-muted small">extension</span> : ''}
  83. </h4>
  84. <p className="mb-1 text-wrap">{localizedTemplate.desc}</p>
  85. { templateLocales != null && Array.from(templateLocales).map(locale => (
  86. <span key={locale} className="badge border rounded-pill text-muted me-1">{locale}</span>
  87. ))}
  88. </DropdownItem>
  89. );
  90. };
  91. type TemplateModalSubstanceProps = {
  92. templateModalStatus: TemplateModalStatus,
  93. close: () => void,
  94. }
  95. const TemplateModalSubstance = (props: TemplateModalSubstanceProps): JSX.Element => {
  96. const { templateModalStatus, close } = props;
  97. const { t } = useTranslation(['translation', 'commons']);
  98. const { data: personalSettingsInfo } = usePersonalSettings();
  99. const { data: rendererOptions } = usePreviewOptions();
  100. const { data: templateSummaries, isLoading } = useSWRxTemplates();
  101. const [selectedTemplateSummary, setSelectedTemplateSummary] = useState<TemplateSummary>();
  102. const [selectedTemplateLocale, setSelectedTemplateLocale] = useState<string>();
  103. const { data: selectedTemplateMarkdown } = useSWRxTemplate(selectedTemplateSummary, selectedTemplateLocale);
  104. const { format } = useFormatter();
  105. const usersDefaultLang = personalSettingsInfo?.lang;
  106. const selectedLocalizedTemplate = getLocalizedTemplate(selectedTemplateSummary, usersDefaultLang);
  107. const selectedTemplateLocales = extractSupportedLocales(selectedTemplateSummary);
  108. const submitHandler = useCallback((markdown?: string) => {
  109. if (markdown == null) {
  110. return;
  111. }
  112. if (templateModalStatus.onSubmit == null) {
  113. close();
  114. return;
  115. }
  116. templateModalStatus.onSubmit(format(selectedTemplateMarkdown));
  117. close();
  118. }, [close, format, selectedTemplateMarkdown, templateModalStatus]);
  119. const onClickHandler = useCallback((
  120. templateSummary: TemplateSummary,
  121. ) => {
  122. let localeToSet: string | Lang | undefined;
  123. if (selectedTemplateLocale != null && selectedTemplateLocale in templateSummary) {
  124. localeToSet = selectedTemplateLocale;
  125. }
  126. else if (usersDefaultLang != null && usersDefaultLang in templateSummary) {
  127. localeToSet = usersDefaultLang;
  128. }
  129. else {
  130. localeToSet = undefined;
  131. }
  132. setSelectedTemplateLocale(localeToSet);
  133. setSelectedTemplateSummary(templateSummary);
  134. }, [selectedTemplateLocale, usersDefaultLang]);
  135. useEffect(() => {
  136. if (!templateModalStatus.isOpened) {
  137. setSelectedTemplateSummary(undefined);
  138. setSelectedTemplateLocale(undefined);
  139. }
  140. }, [templateModalStatus.isOpened]);
  141. return (
  142. <div data-testid="template-modal">
  143. <ModalHeader tag="h4" toggle={close}>
  144. {t('template.modal_label.Select template')}
  145. </ModalHeader>
  146. <ModalBody className="container">
  147. <div className="row">
  148. {/* List Group */}
  149. <div className="d-none d-lg-block col-lg-4">
  150. { isLoading && (
  151. <div className="h-100 d-flex justify-content-center align-items-center">
  152. <LoadingSpinner className="mx-auto text-muted fs-3" />
  153. </div>
  154. ) }
  155. <div className="list-group">
  156. { templateSummaries != null && templateSummaries.map((templateSummary) => {
  157. const templateId = constructTemplateId(templateSummary);
  158. const isSelected = selectedTemplateSummary != null && constructTemplateId(selectedTemplateSummary) === templateId;
  159. return (
  160. <TemplateListGroupItem
  161. key={templateId}
  162. templateSummary={templateSummary}
  163. onClick={() => onClickHandler(templateSummary)}
  164. isSelected={isSelected}
  165. usersDefaultLang={usersDefaultLang}
  166. />
  167. );
  168. }) }
  169. </div>
  170. </div>
  171. {/* Dropdown */}
  172. <div className="d-lg-none col mb-3">
  173. <UncontrolledDropdown>
  174. <DropdownToggle caret type="button" outline className="w-100 text-end" disabled={isLoading}>
  175. <span className="float-start">
  176. { (() => {
  177. if (isLoading) {
  178. return 'Loading..';
  179. }
  180. return selectedLocalizedTemplate != null && selectedLocalizedTemplate.isValid
  181. ? selectedLocalizedTemplate.title
  182. : t('Select template');
  183. })() }
  184. </span>
  185. </DropdownToggle>
  186. <DropdownMenu role="menu" className={`p-0 mw-100 ${styles['dm-templates']}`}>
  187. { templateSummaries != null && templateSummaries.map((templateSummary) => {
  188. const templateId = constructTemplateId(templateSummary);
  189. return (
  190. <TemplateDropdownItem
  191. key={templateId}
  192. templateSummary={templateSummary}
  193. onClick={() => onClickHandler(templateSummary)}
  194. usersDefaultLang={usersDefaultLang}
  195. />
  196. );
  197. }) }
  198. </DropdownMenu>
  199. </UncontrolledDropdown>
  200. </div>
  201. <div className="col-12 col-lg-8">
  202. <div className="row mb-2 mb-lg-0">
  203. <div className="col-6">
  204. <h3>{t('preview')}</h3>
  205. </div>
  206. <div className="col-6 d-flex justify-content-end">
  207. <UncontrolledDropdown>
  208. <DropdownToggle caret type="button" outline className="float-end" disabled={selectedTemplateSummary == null}>
  209. <span className="float-start">{selectedTemplateLocale != null ? selectedTemplateLocale : t('Language')}</span>
  210. </DropdownToggle>
  211. <DropdownMenu className="dropdown-menu" role="menu">
  212. { selectedTemplateLocales != null && Array.from(selectedTemplateLocales).map((locale) => {
  213. return (
  214. <DropdownItem
  215. key={locale}
  216. onClick={() => setSelectedTemplateLocale(locale)}
  217. >
  218. <span>{locale}</span>
  219. </DropdownItem>
  220. );
  221. }) }
  222. </DropdownMenu>
  223. </UncontrolledDropdown>
  224. </div>
  225. </div>
  226. <div className="card">
  227. <div className="card-body" style={{ height: '400px', overflowY: 'auto' }}>
  228. { rendererOptions != null && selectedTemplateSummary != null && (
  229. <Preview rendererOptions={rendererOptions} markdown={format(selectedTemplateMarkdown)} />
  230. ) }
  231. </div>
  232. </div>
  233. </div>
  234. </div>
  235. </ModalBody>
  236. <ModalFooter>
  237. <button type="button" className="btn btn-outline-secondary mx-1" onClick={close}>
  238. {t('Cancel')}
  239. </button>
  240. <button
  241. type="submit"
  242. className="btn btn-primary mx-1"
  243. onClick={() => submitHandler(selectedTemplateMarkdown)}
  244. disabled={selectedTemplateSummary == null}
  245. >
  246. {t('commons:Insert')}
  247. </button>
  248. </ModalFooter>
  249. </div>
  250. );
  251. };
  252. export const TemplateModal = (): JSX.Element => {
  253. const { data: templateModalStatus, close } = useTemplateModal();
  254. if (templateModalStatus == null) {
  255. return <></>;
  256. }
  257. return (
  258. <Modal className="link-edit-modal" isOpen={templateModalStatus.isOpened} toggle={close} size="xl" autoFocus={false}>
  259. { templateModalStatus.isOpened && (
  260. <TemplateModalSubstance templateModalStatus={templateModalStatus} close={close} />
  261. ) }
  262. </Modal>
  263. );
  264. };