A local-first personal finance app
Update Electron help menu to reflect new in-app menu (#3699)
Julian Dominguez-Schatz15351e034eb8
diff --git a/packages/desktop-client/src/components/HelpMenu.tsx b/packages/desktop-client/src/components/HelpMenu.tsxindex 5d69fe0b8d..64eb00081f 100644--- a/packages/desktop-client/src/components/HelpMenu.tsx+++ b/packages/desktop-client/src/components/HelpMenu.tsx@@ -2,15 +2,14 @@ import { forwardRef, useRef } from 'react';import { useHotkeys } from 'react-hotkeys-hook';import { Trans, useTranslation } from 'react-i18next';import { useDispatch } from 'react-redux';-import { useLocation } from 'react-router-dom';import { useToggle } from 'usehooks-ts';+import { openDocsForCurrentPage } from 'loot-core/client/actions';import { pushModal } from 'loot-core/client/actions/modals';import { useFeatureFlag } from '../hooks/useFeatureFlag';import { SvgHelp } from '../icons/v2/Help';-import { openUrl } from '../util/router-tools';import { Button } from './common/Button2';import { Menu } from './common/Menu';@@ -46,26 +45,6 @@ const HelpButton = forwardRef<HTMLButtonElement, HelpButtonProps>(HelpButton.displayName = 'HelpButton';-const getPageDocs = (page: string) => {- switch (page) {- case '/budget':- return 'https://actualbudget.org/docs/getting-started/envelope-budgeting';- case '/reports':- return 'https://actualbudget.org/docs/reports/';- case '/schedules':- return 'https://actualbudget.org/docs/schedules';- case '/payees':- return 'https://actualbudget.org/docs/transactions/payees';- case '/rules':- return 'https://actualbudget.org/docs/budgeting/rules';- case '/settings':- return 'https://actualbudget.org/docs/settings';- default:- // All pages under /accounts, plus any missing pages- return 'https://actualbudget.org/docs';- }-};-export const HelpMenu = () => {const showGoalTemplates = useFeatureFlag('goalTemplatesEnabled');const { t } = useTranslation();@@ -73,12 +52,11 @@ export const HelpMenu = () => {const menuButtonRef = useRef(null);const dispatch = useDispatch();- const page = useLocation().pathname;const handleItemSelect = (item: HelpMenuItem) => {switch (item) {case 'docs':- openUrl(getPageDocs(page));+ dispatch(openDocsForCurrentPage());break;case 'keyboard-shortcuts':dispatch(pushModal('keyboard-shortcuts'));diff --git a/packages/desktop-client/src/components/Titlebar.tsx b/packages/desktop-client/src/components/Titlebar.tsxindex 51018f4542..d80f409c6d 100644--- a/packages/desktop-client/src/components/Titlebar.tsx+++ b/packages/desktop-client/src/components/Titlebar.tsx@@ -7,7 +7,10 @@ import { css } from '@emotion/css';import * as Platform from 'loot-core/src/client/platform';import * as queries from 'loot-core/src/client/queries';import { listen } from 'loot-core/src/platform/client/fetch';-import { isDevelopmentEnvironment } from 'loot-core/src/shared/environment';+import {+ isDevelopmentEnvironment,+ isElectron,+} from 'loot-core/src/shared/environment';import { useActions } from '../hooks/useActions';import { useGlobalPref } from '../hooks/useGlobalPref';@@ -340,7 +343,7 @@ export function Titlebar({ style }: TitlebarProps) {<PrivacyButton />{serverURL ? <SyncButton /> : null}<LoggedInUser />- <HelpMenu />+ {!isElectron() && <HelpMenu />}</SpaceBetween></View>);diff --git a/packages/desktop-client/src/util/router-tools.ts b/packages/desktop-client/src/util/router-tools.tsindex b47386270e..1bba51ee67 100644--- a/packages/desktop-client/src/util/router-tools.ts+++ b/packages/desktop-client/src/util/router-tools.ts@@ -9,7 +9,3 @@ export function ExposeNavigate() {}, [navigate]);return null;}--export function openUrl(url: string) {- window.open(url, '_blank', 'noopener,noreferrer');-}diff --git a/packages/desktop-electron/menu.ts b/packages/desktop-electron/menu.tsindex 60463b8bff..5897cd22d0 100644--- a/packages/desktop-electron/menu.ts+++ b/packages/desktop-electron/menu.ts@@ -1,10 +1,4 @@-import {- MenuItemConstructorOptions,- Menu,- ipcMain,- app,- shell,-} from 'electron';+import { MenuItemConstructorOptions, Menu, ipcMain, app } from 'electron';export function getMenu(isDev: boolean,@@ -173,7 +167,15 @@ export function getMenu(role: 'help',submenu: [{- label: 'Keyboard Shortcuts Reference',+ label: 'Documentation',+ click(_menuItem, focusedWin) {+ focusedWin?.webContents.executeJavaScript(+ 'window.__actionsForMenu && window.__actionsForMenu.openDocsForCurrentPage()',+ );+ },+ },+ {+ label: 'Keyboard Shortcuts',accelerator: '?',enabled: !!budgetId,click: function (_menuItem, focusedWin) {@@ -184,15 +186,6 @@ export function getMenu(}},},- {- type: 'separator',- },- {- label: 'Learn More',- click() {- shell.openExternal('https://actualbudget.org/docs/');- },- },],},];diff --git a/packages/loot-core/src/client/actions/app.ts b/packages/loot-core/src/client/actions/app.tsindex e586f55dc6..6f322b196c 100644--- a/packages/loot-core/src/client/actions/app.ts+++ b/packages/loot-core/src/client/actions/app.ts@@ -52,3 +52,29 @@ export function reloadApp() {global.Actual.reload();};}++const getPageDocs = (page: string) => {+ switch (page) {+ case '/budget':+ return 'https://actualbudget.org/docs/getting-started/envelope-budgeting';+ case '/reports':+ return 'https://actualbudget.org/docs/reports/';+ case '/schedules':+ return 'https://actualbudget.org/docs/schedules';+ case '/payees':+ return 'https://actualbudget.org/docs/transactions/payees';+ case '/rules':+ return 'https://actualbudget.org/docs/budgeting/rules';+ case '/settings':+ return 'https://actualbudget.org/docs/settings';+ default:+ // All pages under /accounts, plus any missing pages+ return 'https://actualbudget.org/docs';+ }+};++export function openDocsForCurrentPage() {+ return () => {+ global.Actual.openURLInBrowser(getPageDocs(window.location.pathname));+ };+}diff --git a/upcoming-release-notes/3699.md b/upcoming-release-notes/3699.mdnew file mode 100644index 0000000000..fc48096744--- /dev/null+++ b/upcoming-release-notes/3699.md@@ -0,0 +1,6 @@+---+category: Enhancements+authors: [jfdoming]+---++Update Electron help menu to reflect new in-app menu