ShortcutsModal.tsx 23 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552
  1. import type React from 'react';
  2. import { useMemo } from 'react';
  3. import { useTranslation } from 'next-i18next';
  4. import { Modal, ModalBody, ModalHeader } from 'reactstrap';
  5. import {
  6. useShortcutsModalActions,
  7. useShortcutsModalStatus,
  8. } from '~/states/ui/modal/shortcuts';
  9. import styles from './ShortcutsModal.module.scss';
  10. /**
  11. * ShortcutsModalSubstance - Presentation component (heavy logic, rendered only when isOpen)
  12. */
  13. const ShortcutsModalSubstance = (): React.JSX.Element => {
  14. const { t } = useTranslation();
  15. const { close } = useShortcutsModalActions();
  16. // Memoize OS-specific class
  17. const additionalClassByOs = useMemo(() => {
  18. const userAgent = window.navigator.userAgent.toLowerCase();
  19. const isMac = userAgent.indexOf('mac') > -1;
  20. return isMac ? 'mac' : 'win';
  21. }, []);
  22. // Memoize body content (large static JSX)
  23. const bodyContent = useMemo(() => {
  24. return (
  25. <div className="container">
  26. <div className="row">
  27. <div className="col-lg-6">
  28. <h6>
  29. <strong>{t('modal_shortcuts.global.title')}</strong>
  30. </h6>
  31. <ul className="list-unstyled m-0">
  32. {/* Open/Close shortcut help */}
  33. <li className="d-flex align-items-center p-3 border-bottom">
  34. <div className="flex-grow-1">
  35. <span
  36. className="text-nowrap"
  37. // biome-ignore lint/security/noDangerouslySetInnerHtml: i18n content includes markup
  38. dangerouslySetInnerHTML={{
  39. __html: t(
  40. 'modal_shortcuts.global.Open/Close shortcut help',
  41. ),
  42. }}
  43. />
  44. </div>
  45. <div className="d-flex align-items-center">
  46. <span className={`key cmd-key ${additionalClassByOs}`}></span>
  47. <span className="text-secondary mx-2">+</span>
  48. <span className="key">/</span>
  49. </div>
  50. </li>
  51. {/* Create Page */}
  52. <li className="d-flex align-items-center p-3 border-bottom">
  53. <div className="flex-grow-1">
  54. {t('modal_shortcuts.global.Create Page')}
  55. </div>
  56. <div>
  57. <span className="key">C</span>
  58. </div>
  59. </li>
  60. {/* Edit Page */}
  61. <li className="d-flex align-items-center p-3 border-bottom">
  62. <div className="flex-grow-1">
  63. {t('modal_shortcuts.global.Edit Page')}
  64. </div>
  65. <div>
  66. <span className="key">E</span>
  67. </div>
  68. </li>
  69. {/* Search */}
  70. <li className="d-flex align-items-center p-3 border-bottom">
  71. <div className="flex-grow-1">
  72. {t('modal_shortcuts.global.Search')}
  73. </div>
  74. <div>
  75. <span className="key">/</span>
  76. </div>
  77. </li>
  78. {/* Show Contributors */}
  79. <li className="d-flex align-items-center p-3 border-bottom">
  80. <div className="flex-grow-1">
  81. <span
  82. className="text-nowrap"
  83. // biome-ignore lint/security/noDangerouslySetInnerHtml: i18n content includes markup
  84. dangerouslySetInnerHTML={{
  85. __html: t('modal_shortcuts.global.Show Contributors'),
  86. }}
  87. />
  88. </div>
  89. <div className="text-start">
  90. <a
  91. href={t('modal_shortcuts.global.konami_code_url')}
  92. target="_blank"
  93. rel="noreferrer"
  94. >
  95. <span className="text-secondary small">
  96. {t('modal_shortcuts.global.Konami Code')}
  97. </span>
  98. </a>
  99. <div className="d-flex gap-2 flex-column align-items-start mt-1">
  100. <div className="d-flex gap-1">
  101. <span className="key material-symbols-outlined fs-5 px-0">
  102. arrow_upward
  103. </span>
  104. <span className="key material-symbols-outlined fs-5 px-0">
  105. arrow_upward
  106. </span>
  107. <span className="key material-symbols-outlined fs-5 px-0">
  108. arrow_downward
  109. </span>
  110. <span className="key material-symbols-outlined fs-5 px-0">
  111. arrow_downward
  112. </span>
  113. </div>
  114. <div className="d-flex gap-1">
  115. <span className="key material-symbols-outlined fs-5 px-0">
  116. arrow_back
  117. </span>
  118. <span className="key material-symbols-outlined fs-5 px-0">
  119. arrow_forward
  120. </span>
  121. <span className="key material-symbols-outlined fs-5 px-0">
  122. arrow_back
  123. </span>
  124. <span className="key material-symbols-outlined fs-5 px-0">
  125. arrow_forward
  126. </span>
  127. </div>
  128. <div className="d-flex gap-1">
  129. <span className="key">B</span>
  130. <span className="key">A</span>
  131. </div>
  132. </div>
  133. </div>
  134. </li>
  135. {/* Mirror Mode */}
  136. <li className="d-flex align-items-center p-3">
  137. <div className="flex-grow-1">
  138. {t('modal_shortcuts.global.MirrorMode')}
  139. </div>
  140. <div className="text-start">
  141. <a
  142. href={t('modal_shortcuts.global.konami_code_url')}
  143. target="_blank"
  144. rel="noreferrer"
  145. >
  146. <span className="text-secondary small">
  147. {t('modal_shortcuts.global.Konami Code')}
  148. </span>
  149. </a>
  150. <div className="d-flex gap-2 flex-column align-items-start mt-1">
  151. <div className="d-flex gap-1">
  152. <span className="key">X</span>
  153. <span className="key">X</span>
  154. <span className="key">B</span>
  155. <span className="key">B</span>
  156. </div>
  157. <div className="d-flex gap-1">
  158. <span className="key">A</span>
  159. <span className="key">Y</span>
  160. <span className="key">A</span>
  161. <span className="key">Y</span>
  162. </div>
  163. <div className="d-flex gap-1">
  164. <span className="key material-symbols-outlined fs-5 px-0">
  165. arrow_downward
  166. </span>
  167. <span className="key material-symbols-outlined fs-5 px-0">
  168. arrow_back
  169. </span>
  170. </div>
  171. </div>
  172. </div>
  173. </li>
  174. </ul>
  175. </div>
  176. <div className="col-lg-6">
  177. <h6>
  178. <strong>{t('modal_shortcuts.editor.title')}</strong>
  179. </h6>
  180. <ul className="list-unstyled m-0">
  181. {/* Search in Editor */}
  182. <li className="d-flex align-items-center p-3 border-bottom">
  183. <div className="flex-grow-1">
  184. {t('modal_shortcuts.editor.Search in Editor')}
  185. </div>
  186. <div className="text-nowrap">
  187. <span className={`key cmd-key ${additionalClassByOs}`}></span>
  188. <span className="text-secondary mx-2">+</span>
  189. <span className="key">F</span>
  190. </div>
  191. </li>
  192. {/* Save Page */}
  193. <li className="d-flex align-items-center p-3 border-bottom">
  194. <div className="flex-grow-1">
  195. {t('modal_shortcuts.editor.Save Page')}
  196. <span className="small text-secondary ms-1">
  197. {t('modal_shortcuts.editor.Only Editor')}
  198. </span>
  199. </div>
  200. <div className="text-nowrap">
  201. <span className={`key cmd-key ${additionalClassByOs}`}></span>
  202. <span className="text-secondary mx-2">+</span>
  203. <span className="key">S</span>
  204. </div>
  205. </li>
  206. {/* Indent */}
  207. <li className="d-flex align-items-center p-3 border-bottom">
  208. <div className="flex-grow-1">
  209. {t('modal_shortcuts.editor.Indent')}
  210. </div>
  211. <div>
  212. <span className="key">Tab</span>
  213. </div>
  214. </li>
  215. {/* Outdent */}
  216. <li className="d-flex align-items-center p-3 border-bottom">
  217. <div className="flex-grow-1">
  218. {t('modal_shortcuts.editor.Outdent')}
  219. </div>
  220. <div className="text-nowrap gap-1">
  221. <span className="key">Shift</span>
  222. <span className="text-secondary mx-2">+</span>
  223. <span className="key">Tab</span>
  224. </div>
  225. </li>
  226. {/* Delete Line */}
  227. <li className="d-flex align-items-center p-3 border-bottom">
  228. <div className="flex-grow-1">
  229. {t('modal_shortcuts.editor.Delete Line')}
  230. </div>
  231. <div className="text-nowrap">
  232. <span className={`key cmd-key ${additionalClassByOs}`}></span>
  233. <span className="text-secondary mx-2">+</span>
  234. <span className="key">Shift</span>
  235. <span className="text-secondary mx-2">+</span>
  236. <span className="key">K</span>
  237. </div>
  238. </li>
  239. {/* Insert Line */}
  240. <li className="d-flex align-items-center p-3 border-bottom">
  241. <div className="flex-grow-1">
  242. <span
  243. // biome-ignore lint/security/noDangerouslySetInnerHtml: i18n content includes markup
  244. dangerouslySetInnerHTML={{
  245. __html: t('modal_shortcuts.editor.Insert Line'),
  246. }}
  247. />
  248. <br />
  249. <span className="small text-secondary ms-1">
  250. {t('modal_shortcuts.editor.Post Comment')}
  251. </span>
  252. </div>
  253. <div className="text-nowrap">
  254. <span className={`key cmd-key ${additionalClassByOs}`}></span>
  255. <span className="text-secondary mx-2">+</span>
  256. <span className="key">Enter</span>
  257. </div>
  258. </li>
  259. {/* Move Line */}
  260. <li className="d-flex align-items-center p-3 border-bottom">
  261. <div className="flex-grow-1">
  262. {t('modal_shortcuts.editor.Move Line')}
  263. </div>
  264. <div className="text-nowrap">
  265. <span className={`key alt-key ${additionalClassByOs}`}></span>
  266. <span className="text-secondary mx-2">+</span>
  267. <span className="key material-symbols-outlined fs-5 px-0">
  268. arrow_downward
  269. </span>
  270. <span className="text-secondary mx-2">or</span>
  271. <span className="key material-symbols-outlined fs-5 px-0">
  272. arrow_upward
  273. </span>
  274. </div>
  275. </li>
  276. {/* Copy Line */}
  277. <li className="d-flex align-items-center p-3 border-bottom">
  278. <div className="flex-grow-1">
  279. {t('modal_shortcuts.editor.Copy Line')}
  280. </div>
  281. <div className="text-nowrap">
  282. <div className="text-start">
  283. <div>
  284. <span
  285. className={`key alt-key ${additionalClassByOs}`}
  286. ></span>
  287. <span className="text-secondary mx-2">+</span>
  288. <span className="key">Shift</span>
  289. <span className="text-secondary ms-2">+</span>
  290. </div>
  291. <div className="mt-1">
  292. <span className="key material-symbols-outlined fs-5 px-0">
  293. arrow_downward
  294. </span>
  295. <span className="text-secondary mx-2">or</span>
  296. <span className="key material-symbols-outlined fs-5 px-0">
  297. arrow_upward
  298. </span>
  299. </div>
  300. </div>
  301. </div>
  302. </li>
  303. {/* Multiple Cursors */}
  304. <li className="d-flex align-items-center p-3">
  305. <div className="flex-grow-1">
  306. {t('modal_shortcuts.editor.Multiple Cursors')}
  307. </div>
  308. <div className="text-nowrap">
  309. <div className="text-end">
  310. <div>
  311. <span
  312. className={`key cmd-key ${additionalClassByOs}`}
  313. ></span>
  314. <span className="text-secondary mx-2">+</span>
  315. <span
  316. className={`key alt-key ${additionalClassByOs}`}
  317. ></span>
  318. <span className="text-secondary ms-2">+</span>
  319. </div>
  320. <div className="mt-1">
  321. <span className="key material-symbols-outlined fs-5 px-0">
  322. arrow_downward
  323. </span>
  324. <span className="text-secondary mx-2">or</span>
  325. <span className="key material-symbols-outlined fs-5 px-0">
  326. arrow_upward
  327. </span>
  328. </div>
  329. <span className="small text-secondary">
  330. {t('modal_shortcuts.editor.Or Alt Click')}
  331. </span>
  332. </div>
  333. </div>
  334. </li>
  335. </ul>
  336. </div>
  337. </div>
  338. {/* Format settings section */}
  339. <div className="row mt-4">
  340. <div className="col-lg-6">
  341. <h6>
  342. <strong>{t('modal_shortcuts.format.title')}</strong>
  343. </h6>
  344. <ul className="list-unstyled m-0">
  345. {/* Bold */}
  346. <li className="d-flex align-items-center p-3 border-bottom">
  347. <div className="flex-grow-1">
  348. {t('modal_shortcuts.format.Bold')}
  349. </div>
  350. <div className="text-nowrap">
  351. <span className={`key cmd-key ${additionalClassByOs}`}></span>
  352. <span className="text-secondary mx-2">+</span>
  353. <span className="key">B</span>
  354. </div>
  355. </li>
  356. {/* Italic */}
  357. <li className="d-flex align-items-center p-3 border-bottom">
  358. <div className="flex-grow-1">
  359. {t('modal_shortcuts.format.Italic')}
  360. </div>
  361. <div className="text-nowrap">
  362. <span className={`key cmd-key ${additionalClassByOs}`}></span>
  363. <span className="text-secondary mx-2">+</span>
  364. <span className="key">Shift</span>
  365. <span className="text-secondary mx-2">+</span>
  366. <span className="key">I</span>
  367. </div>
  368. </li>
  369. {/* Strikethrough */}
  370. <li className="d-flex align-items-center p-3 border-bottom">
  371. <div className="flex-grow-1">
  372. {t('modal_shortcuts.format.Strikethrough')}
  373. </div>
  374. <div className="text-nowrap">
  375. <span className={`key cmd-key ${additionalClassByOs}`}></span>
  376. <span className="text-secondary mx-2">+</span>
  377. <span className="key">Shift</span>
  378. <span className="text-secondary mx-2">+</span>
  379. <span className="key">X</span>
  380. </div>
  381. </li>
  382. {/* Code Text */}
  383. <li className="d-flex align-items-center p-3 border-bottom">
  384. <div className="flex-grow-1">
  385. {t('modal_shortcuts.format.Code Text')}
  386. </div>
  387. <div className="text-nowrap">
  388. <span className={`key cmd-key ${additionalClassByOs}`}></span>
  389. <span className="text-secondary mx-2">+</span>
  390. <span className="key">Shift</span>
  391. <span className="text-secondary mx-2">+</span>
  392. <span className="key">C</span>
  393. </div>
  394. </li>
  395. {/* Hyperlink */}
  396. <li className="d-flex align-items-center p-3">
  397. <div className="flex-grow-1">
  398. {t('modal_shortcuts.format.Hyperlink')}
  399. </div>
  400. <div className="text-nowrap">
  401. <span className={`key cmd-key ${additionalClassByOs}`}></span>
  402. <span className="text-secondary mx-2">+</span>
  403. <span className="key">Shift</span>
  404. <span className="text-secondary mx-2">+</span>
  405. <span className="key">U</span>
  406. </div>
  407. </li>
  408. </ul>
  409. </div>
  410. <div className="col-lg-6">
  411. <h6>
  412. <strong>{t('modal_shortcuts.line_settings.title')}</strong>
  413. </h6>
  414. <ul className="list-unstyled m-0">
  415. {/* Simple List */}
  416. <li className="d-flex align-items-center p-3 border-bottom">
  417. <div className="flex-grow-1">
  418. {t('modal_shortcuts.line_settings.Numbered List')}
  419. </div>
  420. <div className="text-nowrap">
  421. <span className={`key cmd-key ${additionalClassByOs}`}></span>
  422. <span className="text-secondary mx-2">+</span>
  423. <span className="key">Shift</span>
  424. <span className="text-secondary mx-2">+</span>
  425. <span className="key">7</span>
  426. </div>
  427. </li>
  428. {/* Numbered List */}
  429. <li className="d-flex align-items-center p-3 border-bottom">
  430. <div className="flex-grow-1">
  431. {t('modal_shortcuts.line_settings.Bullet List')}
  432. </div>
  433. <div className="text-nowrap">
  434. <span className={`key cmd-key ${additionalClassByOs}`}></span>
  435. <span className="text-secondary mx-2">+</span>
  436. <span className="key">Shift</span>
  437. <span className="text-secondary mx-2">+</span>
  438. <span className="key">8</span>
  439. </div>
  440. </li>
  441. {/* Quote */}
  442. <li className="d-flex align-items-center p-3 border-bottom">
  443. <div className="flex-grow-1">
  444. {t('modal_shortcuts.line_settings.Quote')}
  445. </div>
  446. <div className="text-nowrap">
  447. <span className={`key cmd-key ${additionalClassByOs}`}></span>
  448. <span className="text-secondary mx-2">+</span>
  449. <span className="key">Shift</span>
  450. <span className="text-secondary mx-2">+</span>
  451. <span className="key">9</span>
  452. </div>
  453. </li>
  454. {/* Code Block */}
  455. <li className="d-flex align-items-center p-3 border-bottom">
  456. <div className="flex-grow-1">
  457. {t('modal_shortcuts.line_settings.Code Block')}
  458. </div>
  459. <div className="text-nowrap">
  460. <div className="text-start">
  461. <div>
  462. <span
  463. className={`key cmd-key ${additionalClassByOs}`}
  464. ></span>
  465. <span className="text-secondary mx-2">+</span>
  466. <span
  467. className={`key alt-key ${additionalClassByOs}`}
  468. ></span>
  469. <span className="text-secondary ms-2">+</span>
  470. </div>
  471. <div className="mt-1">
  472. <span className="key">Shift</span>
  473. <span className="text-secondary mx-2">+</span>
  474. <span className="key">C</span>
  475. </div>
  476. </div>
  477. </div>
  478. </li>
  479. {/* Hide comments */}
  480. <li className="d-flex align-items-center p-3">
  481. <div className="flex-grow-1">
  482. {t('modal_shortcuts.line_settings.Comment Out')}
  483. <br />
  484. <span className="small text-secondary">
  485. {t('modal_shortcuts.line_settings.Comment Out Desc')}
  486. </span>
  487. </div>
  488. <div className="text-nowrap">
  489. <span className={`key cmd-key ${additionalClassByOs}`}></span>
  490. <span className="text-secondary mx-2">+</span>
  491. <span className="key">/</span>
  492. </div>
  493. </li>
  494. </ul>
  495. </div>
  496. </div>
  497. </div>
  498. );
  499. }, [additionalClassByOs, t]);
  500. return (
  501. <>
  502. <ModalHeader tag="h4" toggle={close} className="px-4">
  503. {t('Shortcuts')}
  504. </ModalHeader>
  505. <ModalBody className="p-md-4 mb-3 grw-modal-body-style overflow-auto">
  506. {bodyContent}
  507. <div className="mt-4 ps-3">
  508. {/* TODO: Replace href with the dedicated keyboard shortcuts docs page once published */}
  509. <a
  510. href="https://docs.growi.org"
  511. target="_blank"
  512. rel="noreferrer"
  513. className="btn btn-outline-secondary d-inline-flex align-items-center gap-2"
  514. >
  515. <span className="material-symbols-outlined fs-5">help</span>
  516. {t('modal_shortcuts.Other Shortcuts')}
  517. </a>
  518. </div>
  519. </ModalBody>
  520. </>
  521. );
  522. };
  523. /**
  524. * ShortcutsModal - Container component (lightweight, always rendered)
  525. */
  526. export const ShortcutsModal = (): React.JSX.Element => {
  527. const status = useShortcutsModalStatus();
  528. const { close } = useShortcutsModalActions();
  529. return (
  530. <Modal
  531. id="shortcuts-modal"
  532. size="lg"
  533. isOpen={status?.isOpened ?? false}
  534. toggle={close}
  535. className={`shortcuts-modal ${styles['shortcuts-modal']}`}
  536. >
  537. {status?.isOpened && <ShortcutsModalSubstance />}
  538. </Modal>
  539. );
  540. };