A local-first personal finance app
import React, { useState } from 'react';
import type { CSSProperties, SVGAttributes } from 'react';
import { useTranslation } from 'react-i18next';
import { AlignedText } from '@actual-app/components/aligned-text';
import { theme } from '@actual-app/components/theme';
import type {
balanceTypeOpType,
DataEntity,
IntervalEntity,
RuleConditionEntity,
} from '@actual-app/core/types/models';
import { css } from '@emotion/css';
import {
Area,
AreaChart,
CartesianGrid,
LabelList,
Tooltip,
XAxis,
YAxis,
} from 'recharts';
import type { LabelProps } from 'recharts';
import { FinancialText } from '#components/FinancialText';
import { useRechartsAnimation } from '#components/reports/chart-theme';
import { Container } from '#components/reports/Container';
import { useAccounts } from '#hooks/useAccounts';
import { useCategories } from '#hooks/useCategories';
import { useFormat } from '#hooks/useFormat';
import type { FormatType } from '#hooks/useFormat';
import { useNavigate } from '#hooks/useNavigate';
import { usePrivacyMode } from '#hooks/usePrivacyMode';
import { adjustTextSize } from './adjustTextSize';
import { renderCustomLabel } from './renderCustomLabel';
import { showActivity } from './showActivity';
type PayloadItem = {
payload: {
date: string;
totalAssets: number;
totalDebts: number;
netAssets: number;
netDebts: number;
totalTotals: number;
totalBudgeted: number;
};
};
type CustomTooltipProps = {
active?: boolean;
payload?: PayloadItem[];
balanceTypeOp: balanceTypeOpType;
format: (value: unknown, type: FormatType) => string;
};
const CustomTooltip = ({
active,
payload,
balanceTypeOp,
format,
}: CustomTooltipProps) => {
const { t } = useTranslation();
if (active && payload && payload.length) {
return (
<div
className={css({
zIndex: 1000,
pointerEvents: 'none',
borderRadius: 2,
boxShadow: '0 1px 6px rgba(0, 0, 0, .20)',
backgroundColor: theme.menuBackground,
color: theme.menuItemText,
padding: 10,
})}
>
<div>
<div style={{ marginBottom: 10 }}>
<strong>{payload[0].payload.date}</strong>
</div>
<div style={{ lineHeight: 1.5 }}>
{['totalAssets', 'totalTotals', 'totalBudgeted'].includes(
balanceTypeOp,
) && (
<AlignedText
left={t('Assets:')}
right={
<FinancialText>
{format(payload[0].payload.totalAssets, 'financial')}
</FinancialText>
}
/>
)}
{['totalDebts', 'totalTotals', 'totalBudgeted'].includes(
balanceTypeOp,
) && (
<AlignedText
left={t('Debts:')}
right={
<FinancialText>
{format(payload[0].payload.totalDebts, 'financial')}
</FinancialText>
}
/>
)}
{['netAssets'].includes(balanceTypeOp) && (
<AlignedText
left={t('Net Assets:')}
right={
<FinancialText>
{format(payload[0].payload.netAssets, 'financial')}
</FinancialText>
}
/>
)}
{['netDebts'].includes(balanceTypeOp) && (
<AlignedText
left={t('Net Debts:')}
right={
<FinancialText>
{format(payload[0].payload.netDebts, 'financial')}
</FinancialText>
}
/>
)}
{['totalTotals', 'totalBudgeted'].includes(balanceTypeOp) && (
<AlignedText
left={
balanceTypeOp === 'totalBudgeted' ? t('Budgeted:') : t('Net:')
}
right={
<FinancialText as="strong">
{format(
balanceTypeOp === 'totalBudgeted'
? payload[0].payload.totalBudgeted
: payload[0].payload.totalTotals,
'financial',
)}
</FinancialText>
}
/>
)}
</div>
</div>
</div>
);
}
return <div />;
};
const customLabel = ({
props,
width,
end,
format,
}: {
props: LabelProps;
width: number;
end: number;
format: (value: unknown, type: FormatType) => string;
}) => {
//Add margin to first and last object
const calcX =
(typeof props.x === 'number' ? props.x : 0) +
(props.index === end ? -10 : props.index === 0 ? 5 : 0);
const calcY =
(typeof props.y === 'number' ? props.y : 0) -
((typeof props.value === 'number' ? props.value : 0) > 0 ? 10 : -10);
const textAnchor: SVGAttributes<SVGTextElement>['textAnchor'] =
props.index === 0 ? 'start' : 'middle';
const display =
typeof props.value === 'number' && props.value !== 0
? `${format(props.value, 'financial-no-decimals')}`
: '';
const textSize = adjustTextSize({ sized: width, type: 'area' });
return renderCustomLabel(calcX, calcY, textAnchor, display, textSize);
};
// Recharts calls activeDot handlers with the dot's props (including the data
// point) as the second argument, although its types declare a MouseEvent
function hasIntervalPayload(
value: unknown,
): value is { payload: IntervalEntity } {
return value !== null && typeof value === 'object' && 'payload' in value;
}
type AreaGraphProps = {
style?: CSSProperties;
data: DataEntity;
filters?: RuleConditionEntity[];
balanceTypeOp: balanceTypeOpType;
compact?: boolean;
viewLabels: boolean;
showHiddenCategories?: boolean;
showOffBudget?: boolean;
showTooltip?: boolean;
};
export function AreaGraph({
style,
data,
filters = [],
balanceTypeOp,
compact,
viewLabels,
showHiddenCategories = false,
showOffBudget = false,
showTooltip = true,
}: AreaGraphProps) {
const format = useFormat();
const navigate = useNavigate();
const { data: categories = { grouped: [], list: [] } } = useCategories();
const { data: accounts = [] } = useAccounts();
const [pointer, setPointer] = useState('');
const animationProps = useRechartsAnimation({ animationDuration: 1000 });
const privacyMode = usePrivacyMode();
const dataMax = Math.max(...data.intervalData.map(i => i[balanceTypeOp]));
const dataMin = Math.min(...data.intervalData.map(i => i[balanceTypeOp]));
const labelsMargin = viewLabels ? 30 : 0;
const dataDiff = dataMax - dataMin;
const absDataMax = Math.max(Math.abs(dataMax), Math.abs(dataMin));
//Calculate how much to add to max and min values for graph range
const extendRangeAmount = Math.floor(dataDiff / 20);
const labelsMin =
//If min is zero or graph range passes zero then set it to zero
dataMin === 0 || Math.abs(dataMin) <= extendRangeAmount
? 0
: //Else add the range and round to nearest 100s
Math.floor((dataMin - extendRangeAmount) / 100) * 100;
//Same as above but for max
const labelsMax =
dataMax === 0 || Math.abs(dataMax) <= extendRangeAmount
? 0
: Math.ceil((dataMax + extendRangeAmount) / 100) * 100;
const lastLabel = data.intervalData.length - 1;
const tickFormatter = (tick: number) => {
if (!privacyMode) return `${format(tick, 'financial-no-decimals')}`; // Formats the tick values as strings with commas
return '...';
};
const gradientOffset = () => {
if (dataMax <= 0) {
return 0;
}
if (dataMin >= 0) {
return 1;
}
return dataMax / (dataMax - dataMin);
};
const off = gradientOffset();
const leftMargin = Math.abs(absDataMax) > 1000000 ? 20 : 0;
return (
<Container
style={{
...style,
...(compact && { height: 'auto' }),
}}
>
{(width, height) =>
data.intervalData && (
<div>
{!compact && <div style={{ marginTop: '15px' }} />}
<AreaChart
responsive
width={width}
height={height}
data={data.intervalData}
style={{ cursor: pointer }}
margin={{
top: 0,
right: labelsMargin,
left: leftMargin,
bottom: 10,
}}
>
{compact ? null : (
<CartesianGrid strokeDasharray="3 3" vertical={false} />
)}
{compact ? null : (
<XAxis
dataKey="date"
tick={{ fill: theme.pageText }}
tickLine={{ stroke: theme.pageText }}
/>
)}
{compact ? null : (
<YAxis
dataKey={balanceTypeOp}
domain={[
viewLabels ? labelsMin : 'auto',
viewLabels ? labelsMax : 'auto',
]}
tickFormatter={tickFormatter}
tick={{ fill: theme.pageText }}
tickLine={{ stroke: theme.pageText }}
tickSize={0}
/>
)}
{showTooltip && (
<Tooltip
content={
<CustomTooltip
balanceTypeOp={balanceTypeOp}
format={format}
/>
}
isAnimationActive={false}
/>
)}
<defs>
<linearGradient
id={`fill${balanceTypeOp}`}
x1="0"
y1="0"
x2="0"
y2="1"
>
<stop
offset={off}
stopColor={theme.reportsNumberPositive}
stopOpacity={0.2}
/>
<stop
offset={off}
stopColor={theme.reportsNumberNegative}
stopOpacity={0.2}
/>
</linearGradient>
<linearGradient
id={`stroke${balanceTypeOp}`}
x1="0"
y1="0"
x2="0"
y2="1"
>
<stop
offset={off}
stopColor={theme.reportsNumberPositive}
stopOpacity={1}
/>
<stop
offset={off}
stopColor={theme.reportsNumberNegative}
stopOpacity={1}
/>
</linearGradient>
</defs>
<Area
type="linear"
dot={false}
activeDot={{
r: pointer && !compact ? 8 : 3,
onMouseEnter: () => setPointer('pointer'),
onMouseLeave: () => setPointer(''),
onClick: (_, dot: unknown) => {
const intervalItem = hasIntervalPayload(dot)
? dot.payload
: undefined;
const startDate =
intervalItem?.intervalStartDate ?? data.startDate;
if (((compact && showTooltip) || !compact) && startDate) {
showActivity({
navigate,
categories,
accounts,
balanceTypeOp,
filters,
showHiddenCategories,
showOffBudget,
type: 'totals',
startDate,
endDate: intervalItem?.intervalEndDate ?? data.endDate,
});
}
},
}}
{...animationProps}
dataKey={balanceTypeOp}
stroke={`url(#stroke${balanceTypeOp})`}
fill={`url(#fill${balanceTypeOp})`}
fillOpacity={1}
>
{viewLabels && !compact && (
<LabelList
dataKey={balanceTypeOp}
content={props =>
customLabel({
props,
width,
end: lastLabel,
format,
})
}
/>
)}
</Area>
</AreaChart>
</div>
)
}
</Container>
);
}