From 9aa036335906f7594beb778d17d88680c040ded5 Mon Sep 17 00:00:00 2001 From: Tilman Vatteroth Date: Tue, 11 Apr 2023 17:00:20 +0200 Subject: [PATCH] refactor: rename "dark mode" iframe message to "additional configuration" Signed-off-by: Tilman Vatteroth --- ...d-additional-configuration-to-renderer.ts} | 10 +++++----- .../renderer-pane/render-iframe.tsx | 4 ++-- .../render-page/iframe-markdown-renderer.tsx | 4 ++-- .../rendering-message.ts | 19 ++++++++++--------- 4 files changed, 19 insertions(+), 18 deletions(-) rename frontend/src/components/editor-page/renderer-pane/hooks/{use-send-dark-mode-status-to-renderer.ts => use-send-additional-configuration-to-renderer.ts} (82%) diff --git a/frontend/src/components/editor-page/renderer-pane/hooks/use-send-dark-mode-status-to-renderer.ts b/frontend/src/components/editor-page/renderer-pane/hooks/use-send-additional-configuration-to-renderer.ts similarity index 82% rename from frontend/src/components/editor-page/renderer-pane/hooks/use-send-dark-mode-status-to-renderer.ts rename to frontend/src/components/editor-page/renderer-pane/hooks/use-send-additional-configuration-to-renderer.ts index 7b129459d..da970de77 100644 --- a/frontend/src/components/editor-page/renderer-pane/hooks/use-send-dark-mode-status-to-renderer.ts +++ b/frontend/src/components/editor-page/renderer-pane/hooks/use-send-additional-configuration-to-renderer.ts @@ -10,12 +10,12 @@ import { CommunicationMessageType } from '../../../render-page/window-post-messa import { useMemo } from 'react' /** - * Sends the current dark mode setting to the renderer. + * Sends additional configuration options (dark mode, line break, etc.) to the renderer. * - * @param forcedDarkMode Overwrites the value from the global application states if set. * @param rendererReady Defines if the target renderer is ready + * @param forcedDarkMode Overwrites the value from the global application states if set. */ -export const useSendDarkModeStatusToRenderer = ( +export const useSendAdditionalConfigurationToRenderer = ( rendererReady: boolean, forcedDarkMode: DarkModePreference = DarkModePreference.AUTO ): void => { @@ -28,8 +28,8 @@ export const useSendDarkModeStatusToRenderer = ( useSendToRenderer( useMemo( () => ({ - type: CommunicationMessageType.SET_DARKMODE, - preference: darkMode + type: CommunicationMessageType.SET_ADDITIONAL_CONFIGURATION, + darkModePreference: darkMode }), [darkMode] ), diff --git a/frontend/src/components/editor-page/renderer-pane/render-iframe.tsx b/frontend/src/components/editor-page/renderer-pane/render-iframe.tsx index 2cb4d2212..1a024817f 100644 --- a/frontend/src/components/editor-page/renderer-pane/render-iframe.tsx +++ b/frontend/src/components/editor-page/renderer-pane/render-iframe.tsx @@ -22,7 +22,7 @@ import { CommunicationMessageType } from '../../render-page/window-post-message- import { useEditorToRendererCommunicator } from '../render-context/editor-to-renderer-communicator-context-provider' import { useEffectOnRenderTypeChange } from './hooks/use-effect-on-render-type-change' import { useForceRenderPageUrlOnIframeLoadCallback } from './hooks/use-force-render-page-url-on-iframe-load-callback' -import { useSendDarkModeStatusToRenderer } from './hooks/use-send-dark-mode-status-to-renderer' +import { useSendAdditionalConfigurationToRenderer } from './hooks/use-send-additional-configuration-to-renderer' import { useSendMarkdownToRenderer } from './hooks/use-send-markdown-to-renderer' import { useSendScrollState } from './hooks/use-send-scroll-state' import React, { Fragment, useCallback, useEffect, useMemo, useRef, useState } from 'react' @@ -145,7 +145,7 @@ export const RenderIframe: React.FC = ({ ) useEffectOnRenderTypeChange(rendererType, onIframeLoad) - useSendDarkModeStatusToRenderer(rendererReady, forcedDarkMode) + useSendAdditionalConfigurationToRenderer(rendererReady, forcedDarkMode) useSendMarkdownToRenderer(markdownContentLines, rendererReady) useSendScrollState(scrollState, rendererReady) diff --git a/frontend/src/components/render-page/iframe-markdown-renderer.tsx b/frontend/src/components/render-page/iframe-markdown-renderer.tsx index 947bd349e..131cdb814 100644 --- a/frontend/src/components/render-page/iframe-markdown-renderer.tsx +++ b/frontend/src/components/render-page/iframe-markdown-renderer.tsx @@ -53,8 +53,8 @@ export const IframeMarkdownRenderer: React.FC = () => { ) useRendererReceiveHandler( - CommunicationMessageType.SET_DARKMODE, - useCallback((values) => setDarkModePreference(values.preference), []) + CommunicationMessageType.SET_ADDITIONAL_CONFIGURATION, + useCallback((values) => setDarkModePreference(values.darkModePreference), []) ) useRendererReceiveHandler( diff --git a/frontend/src/components/render-page/window-post-message-communicator/rendering-message.ts b/frontend/src/components/render-page/window-post-message-communicator/rendering-message.ts index 75008e367..6884c8eb7 100644 --- a/frontend/src/components/render-page/window-post-message-communicator/rendering-message.ts +++ b/frontend/src/components/render-page/window-post-message-communicator/rendering-message.ts @@ -3,14 +3,15 @@ * * SPDX-License-Identifier: AGPL-3.0-only */ -import type { DarkModePreference } from '../../../redux/dark-mode/types' -import type { ScrollState } from '../../editor-page/synced-scroll/scroll-props' -import type { SlideOptions } from '@hedgedoc/commons' +import type { DarkModePreference } from '../../../redux/dark-mode/types'; +import type { ScrollState } from '../../editor-page/synced-scroll/scroll-props'; +import type { SlideOptions } from '@hedgedoc/commons'; + export enum CommunicationMessageType { SET_MARKDOWN_CONTENT = 'SET_MARKDOWN_CONTENT', RENDERER_READY = 'RENDERER_READY', - SET_DARKMODE = 'SET_DARKMODE', + SET_ADDITIONAL_CONFIGURATION = 'SET_ADDITIONAL_CONFIGURATION', ENABLE_RENDERER_SCROLL_SOURCE = 'ENABLE_RENDERER_SCROLL_SOURCE', DISABLE_RENDERER_SCROLL_SOURCE = 'DISABLE_RENDERER_SCROLL_SOURCE', SET_SCROLL_STATE = 'SET_SCROLL_STATE', @@ -27,9 +28,9 @@ export interface NoPayloadMessage { type: TYPE } -export interface SetDarkModeMessage { - type: CommunicationMessageType.SET_DARKMODE - preference: DarkModePreference +export interface SetAdditionalConfigurationMessage { + type: CommunicationMessageType.SET_ADDITIONAL_CONFIGURATION + darkModePreference: DarkModePreference } export interface ExtensionEvent { @@ -90,7 +91,7 @@ export type CommunicationMessages = | NoPayloadMessage | NoPayloadMessage | NoPayloadMessage - | SetDarkModeMessage + | SetAdditionalConfigurationMessage | SetBaseUrlMessage | GetWordCountMessage | SetMarkdownContentMessage @@ -103,7 +104,7 @@ export type CommunicationMessages = export type EditorToRendererMessageType = | CommunicationMessageType.SET_MARKDOWN_CONTENT - | CommunicationMessageType.SET_DARKMODE + | CommunicationMessageType.SET_ADDITIONAL_CONFIGURATION | CommunicationMessageType.SET_SCROLL_STATE | CommunicationMessageType.SET_BASE_CONFIGURATION | CommunicationMessageType.GET_WORD_COUNT