Skip to content

A local-first personal finance app

:sparkles: (dashboards) ability to quick-edit widget names from inner report pages (#3587)

Matiss Janis Aboltins536949492543
diff --git a/packages/desktop-client/src/components/EditablePageHeaderTitle.tsx b/packages/desktop-client/src/components/EditablePageHeaderTitle.tsx
new file mode 100644
index 0000000000..0552bb4bb3
--- /dev/null
+++ b/packages/desktop-client/src/components/EditablePageHeaderTitle.tsx
@@ -0,0 +1,89 @@
+import React, { useCallback, useEffect, useState } from 'react';
+
+import { SvgPencil1 } from '../icons/v2';
+import { theme } from '../style';
+
+import { Button } from './common/Button2';
+import { InitialFocus } from './common/InitialFocus';
+import { Input } from './common/Input';
+import { View } from './common/View';
+
+type EditablePageHeaderTitleProps = {
+ title: string;
+ onSave: (newValue: string) => void;
+};
+
+export function EditablePageHeaderTitle({
+ title: initialTitle,
+ onSave,
+}: EditablePageHeaderTitleProps) {
+ const [isEditing, setIsEditing] = useState(false);
+ const [title, setTitle] = useState(initialTitle);
+
+ useEffect(() => setTitle(initialTitle), [initialTitle]);
+
+ const onSaveValue = useCallback(
+ (newValue: string) => {
+ onSave(newValue);
+ setTitle(newValue);
+ setIsEditing(false);
+ },
+ [onSave],
+ );
+
+ if (isEditing) {
+ return (
+ <InitialFocus>
+ <Input
+ defaultValue={title}
+ onEnter={e => onSaveValue(e.currentTarget.value)}
+ onBlur={e => onSaveValue(e.target.value)}
+ onEscape={() => setIsEditing(false)}
+ style={{
+ fontSize: 25,
+ fontWeight: 500,
+ marginTop: -3,
+ marginBottom: -3,
+ marginLeft: -6,
+ paddingTop: 2,
+ paddingBottom: 2,
+ width: Math.max(20, title.length) + 'ch',
+ }}
+ />
+ </InitialFocus>
+ );
+ }
+
+ return (
+ <View
+ style={{
+ flexDirection: 'row',
+ alignItems: 'center',
+ gap: 3,
+ '& .hover-visible': {
+ opacity: 0,
+ transition: 'opacity .25s',
+ },
+ '&:hover .hover-visible': {
+ opacity: 1,
+ },
+ }}
+ >
+ {title}
+
+ <Button
+ variant="bare"
+ className="hover-visible"
+ onPress={() => setIsEditing(true)}
+ >
+ <SvgPencil1
+ style={{
+ width: 11,
+ height: 11,
+ color: theme.pageTextSubdued,
+ }}
+ />
+ </Button>
+ </View>
+ );
+}
diff --git a/packages/desktop-client/src/components/reports/Header.tsx b/packages/desktop-client/src/components/reports/Header.tsx
index d9322c2273..7c4705976a 100644
--- a/packages/desktop-client/src/components/reports/Header.tsx
+++ b/packages/desktop-client/src/components/reports/Header.tsx
@@ -1,5 +1,4 @@
import { type ComponentProps, type ReactNode } from 'react';
-import { useLocation } from 'react-router-dom';
import * as monthUtils from 'loot-core/src/shared/months';
import {
@@ -61,8 +60,6 @@ export function Header({
children,
}: HeaderProps) {
const isDashboardsFeatureEnabled = useFeatureFlag('dashboards');
- const location = useLocation();
- const path = location.pathname;
const { isNarrowWidth } = useResponsive();
return (
@@ -73,141 +70,140 @@ export function Header({
flexShrink: 0,
}}
>
- {!['/reports/custom'].includes(path) && (
+ <View
+ style={{
+ flexDirection: isNarrowWidth ? 'column' : 'row',
+ alignItems: isNarrowWidth ? 'flex-start' : 'center',
+ marginTop: 15,
+ gap: 15,
+ }}
+ >
+ {isDashboardsFeatureEnabled && mode && (
+ <Button
+ variant={mode === 'static' ? 'normal' : 'primary'}
+ onPress={() => {
+ const newMode = mode === 'static' ? 'sliding-window' : 'static';
+ const [newStart, newEnd] = calculateTimeRange({
+ start,
+ end,
+ mode: newMode,
+ });
+
+ onChangeDates(newStart, newEnd, newMode);
+ }}
+ >
+ {mode === 'static' ? 'Static' : 'Live'}
+ </Button>
+ )}
+
<View
style={{
- flexDirection: isNarrowWidth ? 'column' : 'row',
- alignItems: isNarrowWidth ? 'flex-start' : 'center',
- marginTop: 15,
- gap: 15,
+ flexDirection: 'row',
+ alignItems: 'center',
+ gap: 5,
}}
>
- {isDashboardsFeatureEnabled && mode && (
- <Button
- variant={mode === 'static' ? 'normal' : 'primary'}
- onPress={() => {
- const newMode = mode === 'static' ? 'sliding-window' : 'static';
- const [newStart, newEnd] = calculateTimeRange({
- start,
+ <Select
+ onChange={newValue =>
+ onChangeDates(
+ ...validateStart(
+ allMonths[allMonths.length - 1].name,
+ newValue,
end,
- mode: newMode,
- });
+ ),
+ )
+ }
+ value={start}
+ defaultLabel={monthUtils.format(start, 'MMMM, yyyy')}
+ options={allMonths.map(({ name, pretty }) => [name, pretty])}
+ />
+ <View>to</View>
+ <Select
+ onChange={newValue =>
+ onChangeDates(
+ ...validateEnd(
+ allMonths[allMonths.length - 1].name,
+ start,
+ newValue,
+ ),
+ )
+ }
+ value={end}
+ options={allMonths.map(({ name, pretty }) => [name, pretty])}
+ style={{ marginRight: 10 }}
+ />
+ </View>
- onChangeDates(newStart, newEnd, newMode);
- }}
+ <View
+ style={{
+ flexDirection: 'row',
+ alignItems: 'center',
+ gap: 15,
+ flexWrap: 'wrap',
+ }}
+ >
+ {show1Month && (
+ <Button
+ variant="bare"
+ onPress={() => onChangeDates(...getLatestRange(1))}
>
- {mode === 'static' ? 'Static' : 'Live'}
+ 1 month
</Button>
)}
-
- <View
- style={{
- flexDirection: 'row',
- alignItems: 'center',
- gap: 5,
- }}
+ <Button
+ variant="bare"
+ onPress={() => onChangeDates(...getLatestRange(2))}
>
- <Select
- onChange={newValue =>
- onChangeDates(
- ...validateStart(
- allMonths[allMonths.length - 1].name,
- newValue,
- end,
- ),
- )
- }
- value={start}
- defaultLabel={monthUtils.format(start, 'MMMM, yyyy')}
- options={allMonths.map(({ name, pretty }) => [name, pretty])}
- />
- <View>to</View>
- <Select
- onChange={newValue =>
- onChangeDates(
- ...validateEnd(
- allMonths[allMonths.length - 1].name,
- start,
- newValue,
- ),
- )
- }
- value={end}
- options={allMonths.map(({ name, pretty }) => [name, pretty])}
- style={{ marginRight: 10 }}
+ 3 months
+ </Button>
+ <Button
+ variant="bare"
+ onPress={() => onChangeDates(...getLatestRange(5))}
+ >
+ 6 months
+ </Button>
+ <Button
+ variant="bare"
+ onPress={() => onChangeDates(...getLatestRange(11))}
+ >
+ 1 Year
+ </Button>
+ <Button
+ variant="bare"
+ onPress={() =>
+ onChangeDates(
+ ...getFullRange(allMonths[allMonths.length - 1].name),
+ )
+ }
+ >
+ All Time
+ </Button>
+
+ {filters && (
+ <FilterButton
+ compact={isNarrowWidth}
+ onApply={onApply}
+ hover={false}
+ exclude={undefined}
/>
- </View>
+ )}
+ </View>
+ {children ? (
<View
style={{
+ flex: 1,
flexDirection: 'row',
- alignItems: 'center',
- gap: 15,
- flexWrap: 'wrap',
+ justifyContent: 'flex-end',
}}
>
- {show1Month && (
- <Button
- variant="bare"
- onPress={() => onChangeDates(...getLatestRange(1))}
- >
- 1 month
- </Button>
- )}
- <Button
- variant="bare"
- onPress={() => onChangeDates(...getLatestRange(2))}
- >
- 3 months
- </Button>
- <Button
- variant="bare"
- onPress={() => onChangeDates(...getLatestRange(5))}
- >
- 6 months
- </Button>
- <Button
- variant="bare"
- onPress={() => onChangeDates(...getLatestRange(11))}
- >
- 1 Year
- </Button>
- <Button
- variant="bare"
- onPress={() =>
- onChangeDates(
- ...getFullRange(allMonths[allMonths.length - 1].name),
- )
- }
- >
- All Time
- </Button>
-
- {filters && (
- <FilterButton
- compact={isNarrowWidth}
- onApply={onApply}
- hover={false}
- exclude={undefined}
- />
- )}
+ {children}
</View>
+ ) : (
+ <View style={{ flex: 1 }} />
+ )}
+ </View>
- {children ? (
- <View
- style={{
- flex: 1,
- flexDirection: 'row',
- justifyContent: 'flex-end',
- }}
- >
- {children}
- </View>
- ) : (
- <View style={{ flex: 1 }} />
- )}
- </View>
- )}
{filters && filters.length > 0 && (
<View style={{ marginTop: 5 }}>
<AppliedFilters
diff --git a/packages/desktop-client/src/components/reports/reports/CashFlow.tsx b/packages/desktop-client/src/components/reports/reports/CashFlow.tsx
index 8a9f8933fa..4714ceb3bc 100644
--- a/packages/desktop-client/src/components/reports/reports/CashFlow.tsx
+++ b/packages/desktop-client/src/components/reports/reports/CashFlow.tsx
@@ -26,6 +26,7 @@ import { Button } from '../../common/Button2';
import { Paragraph } from '../../common/Paragraph';
import { Text } from '../../common/Text';
import { View } from '../../common/View';
+import { EditablePageHeaderTitle } from '../../EditablePageHeaderTitle';
import { MobileBackButton } from '../../mobile/MobileBackButton';
import { MobilePageHeader, Page, PageHeader } from '../../Page';
import { PrivacyFilter } from '../../PrivacyFilter';
@@ -167,12 +168,27 @@ function CashFlowInner({ widget }: CashFlowInnerProps) {
);
}
+ const title = widget?.meta?.name || t('Cash Flow');
+ const onSaveWidgetName = async (newName: string) => {
+ if (!widget) {
+ throw new Error('No widget that could be saved.');
+ }
+
+ const name = newName || t('Cash Flow');
+ await send('dashboard-update-widget', {
+ id: widget.id,
+ meta: {
+ ...(widget.meta ?? {}),
+ name,
+ },
+ });
+ };
+
if (!allMonths || !data) {
return null;
}
const { graphData, totalExpenses, totalIncome, totalTransfers } = data;
- const title = widget?.meta?.name ?? t('Cash Flow');
return (
<Page
@@ -185,7 +201,18 @@ function CashFlowInner({ widget }: CashFlowInnerProps) {
}
/>
) : (
- <PageHeader title={title} />
+ <PageHeader
+ title={
+ widget ? (
+ <EditablePageHeaderTitle
+ title={title}
+ onSave={onSaveWidgetName}
+ />
+ ) : (
+ title
+ )
+ }
+ />
)
}
padding={0}
diff --git a/packages/desktop-client/src/components/reports/reports/NetWorth.tsx b/packages/desktop-client/src/components/reports/reports/NetWorth.tsx
index 5a75a58b95..88e1830214 100644
--- a/packages/desktop-client/src/components/reports/reports/NetWorth.tsx
+++ b/packages/desktop-client/src/components/reports/reports/NetWorth.tsx
@@ -20,6 +20,7 @@ import { theme, styles } from '../../../style';
import { Button } from '../../common/Button2';
import { Paragraph } from '../../common/Paragraph';
import { View } from '../../common/View';
+import { EditablePageHeaderTitle } from '../../EditablePageHeaderTitle';
import { MobileBackButton } from '../../mobile/MobileBackButton';
import { MobilePageHeader, Page, PageHeader } from '../../Page';
import { PrivacyFilter } from '../../PrivacyFilter';
@@ -145,7 +146,21 @@ function NetWorthInner({ widget }: NetWorthInnerProps) {
const navigate = useNavigate();
const { isNarrowWidth } = useResponsive();
- const title = widget?.meta?.name ?? t('Net Worth');
+ const title = widget?.meta?.name || t('Net Worth');
+ const onSaveWidgetName = async (newName: string) => {
+ if (!widget) {
+ throw new Error('No widget that could be saved.');
+ }
+
+ const name = newName || t('Net Worth');
+ await send('dashboard-update-widget', {
+ id: widget.id,
+ meta: {
+ ...(widget.meta ?? {}),
+ name,
+ },
+ });
+ };
if (!allMonths || !data) {
return null;
@@ -162,7 +177,18 @@ function NetWorthInner({ widget }: NetWorthInnerProps) {
}
/>
) : (
- <PageHeader title={title} />
+ <PageHeader
+ title={
+ widget ? (
+ <EditablePageHeaderTitle
+ title={title}
+ onSave={onSaveWidgetName}
+ />
+ ) : (
+ title
+ )
+ }
+ />
)
}
padding={0}
diff --git a/packages/desktop-client/src/components/reports/reports/Spending.tsx b/packages/desktop-client/src/components/reports/reports/Spending.tsx
index a04753b917..8ccd573a19 100644
--- a/packages/desktop-client/src/components/reports/reports/Spending.tsx
+++ b/packages/desktop-client/src/components/reports/reports/Spending.tsx
@@ -26,6 +26,7 @@ import { Select } from '../../common/Select';
import { Text } from '../../common/Text';
import { Tooltip } from '../../common/Tooltip';
import { View } from '../../common/View';
+import { EditablePageHeaderTitle } from '../../EditablePageHeaderTitle';
import { AppliedFilters } from '../../filters/AppliedFilters';
import { FilterButton } from '../../filters/FiltersMenu';
import { MobileBackButton } from '../../mobile/MobileBackButton';
@@ -181,7 +182,21 @@ function SpendingInternal({ widget }: SpendingInternalProps) {
compare === monthUtils.currentMonth() ||
Math.abs(data.intervalData[27].compare) > 0;
- const title = widget?.meta?.name ?? t('Monthly Spending');
+ const title = widget?.meta?.name || t('Monthly Spending');
+ const onSaveWidgetName = async (newName: string) => {
+ if (!widget) {
+ throw new Error('No widget that could be saved.');
+ }
+
+ const name = newName || t('Monthly Spending');
+ await send('dashboard-update-widget', {
+ id: widget.id,
+ meta: {
+ ...(widget.meta ?? {}),
+ name,
+ },
+ });
+ };
return (
<Page
@@ -194,7 +209,18 @@ function SpendingInternal({ widget }: SpendingInternalProps) {
}
/>
) : (
- <PageHeader title={title} />
+ <PageHeader
+ title={
+ widget ? (
+ <EditablePageHeaderTitle
+ title={title}
+ onSave={onSaveWidgetName}
+ />
+ ) : (
+ title
+ )
+ }
+ />
)
}
padding={0}
diff --git a/packages/loot-core/src/server/reports/app.ts b/packages/loot-core/src/server/reports/app.ts
index faa86b1bae..889432c145 100644
--- a/packages/loot-core/src/server/reports/app.ts
+++ b/packages/loot-core/src/server/reports/app.ts
@@ -120,7 +120,7 @@ async function createReport(report: CustomReportEntity) {
const nameExists = await reportNameExists(item.name, item.id ?? '', true);
if (nameExists) {
- throw new Error('There is already a filter named ' + item.name);
+ throw new Error('There is already a report named ' + item.name);
}
// Create the report here based on the info
@@ -140,7 +140,7 @@ async function updateReport(item: CustomReportEntity) {
const nameExists = await reportNameExists(item.name, item.id, false);
if (nameExists) {
- throw new Error('There is already a filter named ' + item.name);
+ throw new Error('There is already a report named ' + item.name);
}
await db.updateWithSchema('custom_reports', reportModel.fromJS(item));
diff --git a/upcoming-release-notes/3587.md b/upcoming-release-notes/3587.md
new file mode 100644
index 0000000000..c2854a83a8
--- /dev/null
+++ b/upcoming-release-notes/3587.md
@@ -0,0 +1,6 @@
+---
+category: Enhancements
+authors: [MatissJanis]
+---
+
+Dashboards: ability to quick-edit widget names from inner report pages.