NavigationContainer.js 6.2 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223
  1. import { Container } from 'unstated';
  2. import loggerFactory from '~/utils/logger';
  3. const logger = loggerFactory('growi:services:NavigationContainer');
  4. /**
  5. * Service container related to options for Application
  6. * @extends {Container} unstated Container
  7. */
  8. const SCROLL_THRES_SKIP = 200;
  9. const WIKI_HEADER_LINK = 120;
  10. export default class NavigationContainer extends Container {
  11. constructor(appContainer) {
  12. super();
  13. this.appContainer = appContainer;
  14. this.appContainer.registerContainer(this);
  15. const { localStorage } = window;
  16. this.state = {
  17. editorMode: 'view',
  18. isDeviceSmallerThanMd: null,
  19. preferDrawerModeByUser: localStorage.preferDrawerModeByUser === 'true',
  20. preferDrawerModeOnEditByUser: // default: true
  21. localStorage.preferDrawerModeOnEditByUser == null || localStorage.preferDrawerModeOnEditByUser === 'true',
  22. isDrawerMode: null,
  23. isDrawerOpened: false,
  24. sidebarContentsId: localStorage.sidebarContentsId || 'recent',
  25. isScrollTop: true,
  26. };
  27. this.setEditorMode = this.setEditorMode.bind(this);
  28. this.initDeviceSize();
  29. this.initScrollEvent();
  30. }
  31. /**
  32. * Workaround for the mangling in production build to break constructor.name
  33. */
  34. static getClassName() {
  35. return 'NavigationContainer';
  36. }
  37. getPageContainer() {
  38. return this.appContainer.getContainer('PageContainer');
  39. }
  40. initDeviceSize() {
  41. const mdOrAvobeHandler = async(mql) => {
  42. let isDeviceSmallerThanMd;
  43. // sm -> md
  44. if (mql.matches) {
  45. isDeviceSmallerThanMd = false;
  46. }
  47. // md -> sm
  48. else {
  49. isDeviceSmallerThanMd = true;
  50. }
  51. this.setState({ isDeviceSmallerThanMd });
  52. this.updateDrawerMode({ ...this.state, isDeviceSmallerThanMd }); // generate newest state object
  53. };
  54. this.appContainer.addBreakpointListener('md', mdOrAvobeHandler, true);
  55. }
  56. initScrollEvent() {
  57. window.addEventListener('scroll', () => {
  58. const currentYOffset = window.pageYOffset;
  59. // original throttling
  60. if (SCROLL_THRES_SKIP < currentYOffset) {
  61. return;
  62. }
  63. this.setState({
  64. isScrollTop: currentYOffset === 0,
  65. });
  66. });
  67. }
  68. setEditorMode(editorMode) {
  69. const { isNotCreatable } = this.getPageContainer().state;
  70. if (this.appContainer.currentUser == null) {
  71. logger.warn('Please login or signup to edit the page or use hackmd.');
  72. return;
  73. }
  74. if (isNotCreatable) {
  75. logger.warn('This page could not edit.');
  76. return;
  77. }
  78. this.setState({ editorMode });
  79. if (editorMode === 'view') {
  80. $('body').removeClass('on-edit');
  81. $('body').removeClass('builtin-editor');
  82. $('body').removeClass('hackmd');
  83. $('body').removeClass('pathname-sidebar');
  84. window.history.replaceState(null, '', window.location.pathname);
  85. }
  86. if (editorMode === 'edit') {
  87. $('body').addClass('on-edit');
  88. $('body').addClass('builtin-editor');
  89. $('body').removeClass('hackmd');
  90. // editing /Sidebar
  91. if (window.location.pathname === '/Sidebar') {
  92. $('body').addClass('pathname-sidebar');
  93. }
  94. window.location.hash = '#edit';
  95. }
  96. if (editorMode === 'hackmd') {
  97. $('body').addClass('on-edit');
  98. $('body').addClass('hackmd');
  99. $('body').removeClass('builtin-editor');
  100. $('body').removeClass('pathname-sidebar');
  101. window.location.hash = '#hackmd';
  102. }
  103. this.updateDrawerMode({ ...this.state, editorMode }); // generate newest state object
  104. }
  105. toggleDrawer() {
  106. const { isDrawerOpened } = this.state;
  107. this.setState({ isDrawerOpened: !isDrawerOpened });
  108. }
  109. /**
  110. * Set Sidebar mode preference by user
  111. * @param {boolean} preferDockMode
  112. */
  113. async setDrawerModePreference(bool) {
  114. this.setState({ preferDrawerModeByUser: bool });
  115. this.updateDrawerMode({ ...this.state, preferDrawerModeByUser: bool }); // generate newest state object
  116. // store settings to localStorage
  117. const { localStorage } = window;
  118. localStorage.preferDrawerModeByUser = bool;
  119. }
  120. /**
  121. * Set Sidebar mode preference by user
  122. * @param {boolean} preferDockMode
  123. */
  124. async setDrawerModePreferenceOnEdit(bool) {
  125. this.setState({ preferDrawerModeOnEditByUser: bool });
  126. this.updateDrawerMode({ ...this.state, preferDrawerModeOnEditByUser: bool }); // generate newest state object
  127. // store settings to localStorage
  128. const { localStorage } = window;
  129. localStorage.preferDrawerModeOnEditByUser = bool;
  130. }
  131. /**
  132. * Update drawer related state by specified 'newState' object
  133. * @param {object} newState A newest state object
  134. *
  135. * Specify 'newState' like following code:
  136. *
  137. * { ...this.state, overwriteParam: overwriteValue }
  138. *
  139. * because updating state of unstated container will be delayed unless you use await
  140. */
  141. updateDrawerMode(newState) {
  142. const {
  143. editorMode, isDeviceSmallerThanMd, preferDrawerModeByUser, preferDrawerModeOnEditByUser,
  144. } = newState;
  145. // get preference on view or edit
  146. const preferDrawerMode = editorMode !== 'view' ? preferDrawerModeOnEditByUser : preferDrawerModeByUser;
  147. const isDrawerMode = isDeviceSmallerThanMd || preferDrawerMode;
  148. const isDrawerOpened = false; // close Drawer anyway
  149. this.setState({ isDrawerMode, isDrawerOpened });
  150. }
  151. selectSidebarContents(contentsId) {
  152. window.localStorage.setItem('sidebarContentsId', contentsId);
  153. this.setState({ sidebarContentsId: contentsId });
  154. }
  155. /**
  156. * Function that implements the click event for realizing smooth scroll
  157. * @param {array} elements
  158. */
  159. addSmoothScrollEvent(elements = {}) {
  160. elements.forEach(link => link.addEventListener('click', (e) => {
  161. e.preventDefault();
  162. const href = link.getAttribute('href').replace('#', '');
  163. window.location.hash = href;
  164. const targetDom = document.getElementById(href);
  165. this.smoothScrollIntoView(targetDom, WIKI_HEADER_LINK);
  166. }));
  167. }
  168. smoothScrollIntoView(element = null, offsetTop = 0) {
  169. const targetElement = element || window.document.body;
  170. // get the distance to the target element top
  171. const rectTop = targetElement.getBoundingClientRect().top;
  172. const top = window.pageYOffset + rectTop - offsetTop;
  173. window.scrollTo({
  174. top,
  175. behavior: 'smooth',
  176. });
  177. }
  178. }